Create hook_help for entity reference

Working on this...

Implemented hook_help() for the Entity Reference module.
The actual help text should be reviewed.

We need to standardize the way we refer to "entities" in the field help text. I've opened a separate issue to discuss this:
#2030569: [policy] Decide how to refer to "entities" and "bundles" in D8 UI

This issue should (sorry!) be postponed until that other one is decided.

That's been downgraded to normal so unpostponing this one.

This patch doesn't really follow the proposed standards on #2030569: [policy] Decide how to refer to "entities" and "bundles" in D8 UI. We should also avoid in this help describing the basics of fields or of how to do field stuff, and instead refer people to the Field and Field UI help modules.

There are still some problems with this text:

a) Grammar point: "defines a field type for the Field module, that lets " : that -> which

b) This is garbled: lets you create links... within Drupal manage -- what is Drupal manage?

c) The link to the online docs is not following our hook_help standards.

Well there are a lot of other obvious typos. Please proofread the help and submit a new patch. Make sure to read it through before submitting. Thanks!

Better!

(a) and (c) from #9 still apply, however.

And I think the Uses section could use some rewriting.

In the first Uses bullet, ... we've already stated that it's a field in "About", so why do we need to conclude "therefore add a field" in the Uses section? It just doesn't make sense to me. Didn't we come up with some standard ways to document field modules? Let's use those here.

In the second Uses bullet, ... It doesn't seem like "but" is the right conjunction here -- these are just two equally valid possibilities for display, not "You could do this, but if you did, ...". Maybe "Alternatively"? And I don't think the wording on that second sentence is at all clear. I know what it is trying to say, but I don't think it gets the point across?

Looking pretty good! A few minor things:

a) "defines a field type which lets you create links" which -> that

b) On other field modules, we have a Uses item explaining what field settings and display settings are. This is missing here.

Looks good other than that!

(a) is still not fixed from #14. And I think the item about the display and field settings should come first in Uses?
Then the "adding" item can say whether the things referenced are display or field settings.

Also, I think it's best to use the standard "display and field settings" item in Uses, and then have a separate item that talks about the specific display settings, rather than merging them into one Uses item?

Finally, maybe we should have a link to the Entity module help (which may not exist yet but which we expect will explain what entities are?).

Great work - go batigolix ! You must be on a personal "fix all the hook_help" sprint these past few days. :)

I noticed a new thing to fix: We shouldn't be using the word "node" -- say "content item".

And I think maybe my idea about reordering the Uses items didn't work very well.. the intention was that in the Adding bullet point, it would reference field settings, but it doesn't actually say those are field settings... Really, we don't need an "Adding" bullet point anyway -- adding a field is covered by the Field UI module, and it is fairly generic. We should instead have a bullet point with the word "settings" in its heading, maybe "Configuring entity reference field settings"? There we would talk about the settings, and leave out the stuff about how to add the field?

On the same Coding Standards page that says not to use "Node", it says not to use "Drupal" either:
https://drupal.org/node/604342#wording

That aside, I think this latest patch is looking good! One other thought:

The parenthetical remark in About that says where to learn about entities and fields... I think it is more related to the first sentence than the second sentence? So let's either (1) put it in the first sentence or (2) take out the parens and combine it with the "for more information" last sentence? It just doesn't seem related to the sentence it is currently inside.

I think this is nearly ready to go! Thanks!

RE mentions of Drupal -- the end of the first sentence of About. Node was never there.

I think the current patch is really good, except that mention of Drupal. And also since we are now differentiating between field settings and display settings, I think we need to say "in the field settings" in the "Filtering and sorting" item,

Excellent work! I think this one is ready for a quick manual test:
- Verify that all the links work
- Verify that all mentions of pages/text within the UI match what is seen in the UI
- Verify that the formatting is OK.

Thanks @batigolix text looks really good :)

I gave this a manual test today and I think it is all looking good except for one very minor item in About:

"see the online documentation for the Entity Reference module, the Entity module help page and the Field module help page."

There should be a comma before "and" here.

And technically, in the Display section, you can display the entity label with or without a link, and there are other display choices as well (which I guess we don't really need to mention).

Thanks! Let's get this one in.

Back to documentation component in case I am doing commits before someone else gets to it. (I only look at issues in Documentation when I'm doing commits.)

Thanks again! Committed to 8.x.

Patch fails now. Tested on 8.0.x and 8.1.x

Does this need a re-roll?

If so, happy to do it.

@no_angel: Not sure what you mean here. This issue was marked fixed two years ago. Since then, entity_reference was absorbed into core and you will find the help text in field.module.

I commented on the other issue about this. This module does not exist -- the field is part of Core not in a module now. The patch was committed but the file/function do not exist now. Issue was closed two years ago.