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:
a) [done, patch attached] review / write the hook_help text according to help guidelines

b) (novice) Final manual testing
1. Apply the patch.
2. Go to admin/help.
3. Click on the help page for this module (Content Translation).
4. Verify that the help page is OK:
- Verify that all the links work
- Verify that all mentions of pages/text/permissions within the UI match what is seen in the UI
- Verify that the formatting is OK.

Files: 
CommentFileSizeAuthor
#57 interdiff-52-57.txt2.32 KBmartin107
#57 update-hook-help-content-translation-2091479-57.patch7.49 KBmartin107
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,738 pass(es).
[ View ]
#52 update-hook-help-content-translation-2091479-52.patch7.5 KBfran seva
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,753 pass(es).
[ View ]
#52 interdiff-49-52.txt16.52 KBfran seva
#49 update-hook-help-content-translation-2091479-49.patch19.52 KBsoipo
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,627 pass(es).
[ View ]
#49 interdiff-2091479-43-49.txt8.71 KBsoipo
#44 colorwords.png320.45 KBYesCT
#44 interdiff.2091479.38.43.txt2.37 KBYesCT
#43 update-hook-help-content-translation-2091479-43.patch7.51 KBamitgoyal
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,615 pass(es).
[ View ]
#40 Content-translation-help-page-20140516.png125.16 KBjlbellido
#38 update-hook-help-content-translation-2091479-38.patch7.54 KBmartin107
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 70,552 pass(es).
[ View ]
#32 interdiff.txt6.47 KBbatigolix
#32 update-hook-help-content-translation-2091479-32.patch7.53 KBbatigolix
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 66,976 pass(es).
[ View ]
#30 interdiff.txt7.63 KBbatigolix
#30 update-hook-help-content-translation-2091479-30.patch7.46 KBbatigolix
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 67,040 pass(es).
[ View ]
#22 update-hook-help-content-translation-2091479-22.patch7.49 KBifrik
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 66,851 pass(es).
[ View ]
#22 interdiff-18-22.txt7.17 KBifrik
#19 update-hook-help-content-translation-2091479-18.patch6.36 KBjlbellido
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 66,810 pass(es).
[ View ]
#19 interdiff.txt3.75 KBjlbellido
#16 interdiff-2091479-14-16.txt5.87 KBInternetDevels
#16 update-hook-help-content-translation-2091479-16.patch6.23 KBInternetDevels
PASSED: [[SimpleTest]]: [MySQL] 63,715 pass(es).
[ View ]

Comments

jhodgdon’s picture

Title:Update hook_help for Translation Entity module» Update hook_help for content_translation module

Module name changed.

vzblk’s picture

Status:Active» Needs review
StatusFileSize
new3.73 KB
FAILED: [[SimpleTest]]: [MySQL] Invalid patch format in drupal8.documentation.2091479-2.patch.
[ View ]
vzblk’s picture

Assigned:Unassigned» vzblk

Status:Needs review» Needs work

The last submitted patch, drupal8.documentation.2091479-2.patch, failed testing.

vzblk’s picture

StatusFileSize
new3.71 KB
vzblk’s picture

Status:Needs work» Needs review
StatusFileSize
new3.71 KB
vzblk’s picture

StatusFileSize
new3.71 KB
PASSED: [[SimpleTest]]: [MySQL] 58,581 pass(es).
[ View ]
vzblk’s picture

Status:Needs review» Active
m1r1k’s picture

Status:Active» Needs review

Testbot expects *.patch files, but *.patch.txt given

vzblk’s picture

StatusFileSize
new3.71 KB
PASSED: [[SimpleTest]]: [MySQL] 59,019 pass(es).
[ View ]
jhodgdon’s picture

Status:Needs review» Needs work

Thanks for the patches, and sorry for the delay in reviewing -- the help sprint was so successful, I have been having trouble catching up!

The help for this module needs some more work besides what is in this patch:

a) The reference to the on-line documentation in About is not following our guidelines:
https://drupal.org/node/632280
b) In "enabling translation" in Uses, second paragraph, we should have the link text be the actual page title. So it should say something like "After adding languages, configure translation on the (link)Whatever whatever whatever page(end of link)." and have the "whatevers" match the actual page title. This also needs to be fixed in the Permissions item in Uses.
c) Our standard in Drupal is to use serial commas in lists, such as "dogs, cats, or horses". This comma is missing before and/or in at least one case (in Translating Content). Check for other cases too?
d) When using apostrophes in text, enclose the entire text in double quotes rather than using \' to escape the quote. (That applies to Changing Source Language).

InternetDevels’s picture

Issue summary:View changes
Status:Needs work» Needs review
Parent issue:» #1908570: [meta] Update or create hook_help() texts for D8 core modules
StatusFileSize
new5.36 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch update-hook-help-content-translation-2091479-12.patch. Unable to apply patch. See the log in the details link for more information.
[ View ]

The file was changed and we can not apply old patch, so we did not create interdiff.
Fixed issues from comment #11.

Status:Needs review» Needs work

The last submitted patch, 12: update-hook-help-content-translation-2091479-12.patch, failed testing.

InternetDevels’s picture

Status:Needs work» Needs review
StatusFileSize
new5.36 KB
PASSED: [[SimpleTest]]: [MySQL] 59,879 pass(es).
[ View ]
jhodgdon’s picture

Status:Needs review» Needs work

Thanks for the rerolls... The patch still needs some work:

1. One thing I forgot in the last review: We don't actually want to use the word "Drupal" in any text inside Drupal, as much as possible. See https://drupal.org/node/604342 under "Wording".

2. It looks like item (a) from #11 has not been addressed.

3. Regarding #11 (c) the commas are still not right. See http://grammar.about.com/od/grammarfaq/f/QAoxfordcomma.htm

Specific examples:
- "From there, you can add translations and edit, or delete existing translations."
===> there should not be a comma before "or" here -- it is not a list.
- "This process is similar for every translatable element on your site, such as taxonomy terms, comments or user accounts."
===> There should be a comma before "or" here, because it is a list.

4. The "Maintaining Translations" Uses header was dropped in the latest patch.

5. There are still some calls to url(). See https://drupal.org/node/632280#url-note

InternetDevels’s picture

Status:Needs work» Needs review
StatusFileSize
new6.23 KB
PASSED: [[SimpleTest]]: [MySQL] 63,715 pass(es).
[ View ]
new5.87 KB

Tried fix all issues.

jhodgdon’s picture

Status:Needs review» Needs work

Much better, thanks!

There are still some issues:

a) There is no module called "Locale" in Drupal 8. The module whose machine name is "locale" is now called "Interface Translation", and there is a separate module whose machine name is "language" that is called "Language". The "About" text referring to the "Locale" module is not accurate any more -- the Language module is where you configure languages, and the "Interface Translation" module is what lets you translate the user interface.

b) When referring to this module, it should be called "the Content Translation module" (note the capitalization).

c) Check the help standards (https://drupal.org/node/632280) for the standard way to link to the on-line docs. Still isn't right. Also it seems to be linking to http://drupal.org/documentation/modules/translation_entity -- it should be http://drupal.org/documentation/modules/content_translation, and if that doesn't exist, we should create it.

d) We seem to have lost this Uses item in this patch:

-      $output .= '<dt>' . t('Maintaining translations') . '</dt>';
-      $output .= '<dd>' . t('If editing content in one language requires that translated versions also be updated to reflect the change, use the <em>Flag other translations as outdated</em> check box to mark the translations as outdated and in need of revision.') . '</dd>';

Is there a reason for that? It seems like good information.

jlbellido’s picture

I'm working on this.

jlbellido’s picture

Status:Needs work» Needs review
StatusFileSize
new3.75 KB
new6.36 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 66,810 pass(es).
[ View ]

I've made the following changes sugested by @ jhodgdon:

a) Updated 'locale' references to 'Interface Transation' and I splited Language and Interface Translation mention at 'About'.
b) I updated references to 'Content Translation module' to capital letters.
c) I Updated the link to Content translation Drupal.org documentation. There isn't a page at Drupal.org documentation for Content Translation module, we should create it.
d) Added 'Maintaining translations' section to the patch.

Thanks to @jhodgdon for review it.

jhodgdon’s picture

Status:Needs review» Needs work

Thanks -- looking pretty good! A few mostly minor things to fix:

a) Translating bullet point:

...tab or link that will gives an overview of the translation status...

take out "will" here.

b) In the Changing source language bullet point... I wasn't sure what this referred to. Is this when you are already in the middle of translating an item? If so, maybe start the text with "When you are translating content, if there are two or more..."?

c) In the Permissions section... So, the first sentence says that the module gives you basic permissions, but doesn't explain what they are or what they do. Then the next sentence says there are also additional permissions, and says that these can be configured on the Permissions page, which kind of implies that the basic ones can't? So... I just think this is kind of confusing.

d) "translatable element"... hmmm... The About section says the module lets you translate "content", and the word "content" is used for a while. Then suddenly the text starts talking about "translatable element". ?!? What is this? We should probably just use the word "entity", which we are using in other help text? And we should use the same terminology throughout, I think?

ifrik’s picture

jbellio - I'm working on it in room Magratea now. Find me there or on IRC if that overlaps with something you are doing at the moment.

ifrik’s picture

Status:Needs work» Needs review
StatusFileSize
new7.17 KB
new7.49 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 66,851 pass(es).
[ View ]

I've taken up the comments above.
I've also added the Configuration Translation in the About section to make it complete.

Added a section about field level translation. There is a usability issue there, because contrary at least to my expectation, fields that are not checked as translatable show up on the translation form, and if you edit them they just change all translation instances of that content. I had assumed that they wouldn't show up, and ended up overwritting my content. That's why I made that clearer in the Uses section, but I hope that can be changed further - in which case the help text will need to be changed.

I've deleted the Permissions use because there isn't anything different from permission settings of any other module.
And I've changed the title of "Maintaing translation" to "Flagging translations as outdated" to make it more obvious.

Also changing the links for modules that don't have to be enabled.

ifrik’s picture

Status:Needs review» Needs work

I've just noted that we forgot to cover the "Content language detection" on /admin/config/regional/language/detection

batigolix’s picture

Good stuff!

I reviewed the patch.

Formatting is Okay

I would propose some rewriting, though:

a)

The Content Translation module allows content to be translated into different languages.
.Working with the Interface Translation and the Configuration Translation modules (which provide translation for the site interface and configuration if they are enabled) and Language module (which manages languages), the Content Translation module is key to creating and maintaining translated site content.

This is difficult to read and contains bits of marketing-speak. How about:

The Content Translation module allows you to translate content. It complements the Configuration Translation and Interface Translation modules that allow you to translate configuration text and built-in interface text.

b)

You then need configure which content entities

should be:

You then need to configure which content entities

c)

In order to translate content, there must be at least two languages listed on the Languages page. You then need configure which content entities can be translated on the Content Translation page. For more information on languages, see the Languages help page.

I would write:

In order to translate content, you must have at least two languages enabled. Then you can define which content entities can be translated on the Content Translation page.

With links on the words "languages" and "Content Translation" and given the complexity of the concept, I would put a link to the entity help page on "content entities"

d)

If you exclude a field, it still shows up in the translation form, but any edits made to that field will be applied to all translations of that content.

I would put

If you exclude a field, it will still show up in the translation form, but any changes made to that field will be applied to all translations of that content.

e)

Then, you will see a Translate tab or link

Why these 2 situations? Is it not always a tab?

batigolix’s picture

Component:documentation» content_translation.module

Changing component and linking this to #1188388: Entity translation UI in core to get feedback from maintainers.

YesCT’s picture

+++ b/core/modules/content_translation/content_translation.module
@@ -24,27 +24,26 @@ function content_translation_help($path, $arg) {
       $output .= '<dt>' . t('Translating content') . '</dt>';
-      $output .= '<dd>' . t('After enabling translation you can create a new piece of content, or edit existing content and assign it a language. Then, you will see a <em>Translate</em> tab or link that will gives an overview of the translation status for the current content. From there, you can add translations and edit or delete existing translations. This process is similar for every translatable element on your site, such as taxonomy terms, comments or user accounts.') . '</dd>';
...
+      $output .= '<dd>' . t('After enabling translation you can create new content, or edit existing content by assigning it a language. Then, you will see a <em>Translate</em> tab or link that gives an overview of the translation status for the current content. From there, you can add translations and edit or delete existing translations. This process is similar for every translatable content entity on your site, such as taxonomy terms, comments, or menu links.') . '</dd>';

"After enabling translation you can create new content, or edit existing content by assigning it a language. "

by assigning, does not make sense.
also I think this is left over from before.
we do not need to edit existing content and set a language for it. now, all content has a language.
also, the ability to change the language of content is provided by the language module, not the content translation module.

batigolix’s picture

Assigned:vzblk» batigolix

i take this

ifrik’s picture

Batigolix: take #23 into account - we forgot the interface language detection methods based on the content language

batigolix’s picture

will do! need some time though. devdays have drained my batteries

batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new7.46 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 67,040 pass(es).
[ View ]
new7.63 KB

Batteries reloaded! Let's wash this piglet (well known Dutch expression)

Attached patch addresses the points made in #24 and #26.

a) I should apologize to Ifrik for drastically changing her work, but the only way for me to fix some bits was by changing its context and this lead to a complete rewrite. In its core it is still your text, though ;)

b) I cannot reproduce the section under "Changing the source language for a translation". You have a screenshot or URL where I can see this at work?

c) I encountered some pretty funky UI texts when working on this hook_help. We need to notify the UX team about this possibly postpone this issue until this has been fixed. We already discussed this in Szeged.

d) Maybe we should use a common introduction for all the 4 modules of the multilingual suite?

e) Given the drastic changes, I expect a couple of grammatical and spelling error, so this needs a decent review.

jhodgdon’s picture

Status:Needs review» Needs work

Hm. I'm not sure I want to wash any piglets, but I've at least reviewed the patch. :)

Proofreading:

a) in About:
... Configuration Translation[needs comma here!] and Interface Translation[comma here!] it allows

b) In Field uses bullet point:
... Typically you want to translate the title and body field while leaving the image field untranslated. ...
I think here we should maybe say "For example, you might want to..." instead?

c) In Translating Content bullet point:
... Translation tab (or Translation link). The Translations page ...
Um. Is it Translation or Translations? Hm... in the UI that I see, for Content (node) items anyway, the tab is calleld "Translate".

d) Same point:
...add, edit[needs comma here!] and delete its translations...

Also...

e) I like your idea of making all of the language-related modules have similar About sections.

f) I tried out the "source language" stuff too. What I did:
- Enabled Content Translation and Language modules.
- Added French and Spanish
- Set up Page and Article nodes as translatable
- Created a page in English.
- Translated it to French.
- Clicked Translate again, and then clicked Add for Spanish.
- Near the top, there is a collapsed fieldset with title "Source language: English". I can open this and it allows me to change the source language to French. And as stated in the help, after saving the source language I chose does show up in the Translate tab.

So... I would suggest the following wording for this bullet item:

When you add a new translation, the original text you are translating is displayed in the edit form as the source. If at least one translation of the original content already exists when you add a new translation, you can choose either the original content (default) or one of the other translations as the source, using the form at the top of the page. After saving the translation, the chosen source language is then listed on the Translate tab of the content.

batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new7.53 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 66,976 pass(es).
[ View ]
new6.47 KB

Patch that addresses point in #31:

a) done
b) done
c) the tabs is named Translate, the page is named Translations (done, but this might need to be adjusted after a UI string review)
d) done
e) OK. keep in our minds for the other 3 language modules, with the About of Content Translation as a model
f) Ok, I see this now in action after I enabled a 3rd language. Not the prettiest UI. I changed the wording a tiny bit to prevent having to say "on the top of the page" as such element can be easily replaced

jhodgdon’s picture

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

jhodgdon’s picture

Issue summary:View changes

Updated issue summary to make clear what the remaining (novice) task is.

YesCT’s picture

Issue summary:View changes
Gábor Hojtsy’s picture

Issue tags:+D8MI, +language-content

Tagging with D8MI topic tags.

jhodgdon’s picture

Status:Needs review» Needs work

We just had a change to hook_help, on this issue: #2183113: Update hook_help signature to use route_name instead of path.

Here is the change record: https://drupal.org/node/2250345

This patch will need a reroll for this change.

martin107’s picture

Status:Needs work» Needs review
StatusFileSize
new7.54 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 70,552 pass(es).
[ View ]

Straight reroll of #32.

Line 10 has 1,059 characters in it... a little over the 80 character barrier!
Made checking this patch very hard.

jhodgdon’s picture

Thanks for the reroll, which looks perfect!

The patch still needs manual testing -- see #33.

jlbellido’s picture

Status:Needs review» Needs work
StatusFileSize
new125.16 KB

I've tested manually and this are the results:

1. Apply the patch. --> OK, the patch applies.
2. Go to admin/help. --> Ok,
3. Click on the help page for this module (Content Translation). --> Ok
4. Verify that the help page is OK:
- Verify that all the links work
- Content entities link --> OK, It links to admin/help/entity
- Language link --> OK, It links to admin/help/language
- Configuration Translation link --> Ok, If Configuration translation is enabled, it links to admin/help/config_translation.
- Interface Translation link --> OK, If locale module is enabled, it links to admin/help/locale
- Online documentation for the Content Translation module link --> FAIL , Content Translation documentation page at d.o doesn't exists (https://drupal.org/documentation/modules/content_translation)
- Language link at Enabling translation section --> FAIL , it doesn't work
- Content translation link at Enabling translation section --> OK, it links to admin/config/regional/content-language

- Verify that all mentions of pages/text/permissions within the UI match what is seen in the UI : Ok, It seems that is ok.
- Verify that the formatting is OK. --> It seems OK, attached a screenshot

jhodgdon’s picture

Thanks for testing!

Regarding the drupal.org link, we'll need to create the page.

Regarding the other link, it sounds like the patch needs an update.

fran seva’s picture

@jhodgdon @jlbellido I have reviewed the patch and I see that the Enabling translation text is wrong, I mean:
The text in t() is :
'In order to translate content, the website must have at least two languages enabled. When that is the case, you can enable translation for the desired content entities on the Content Translation page. When enabling translation you can choose the default language for content and decide whether to show the language selection field on the content editing forms.
The parameters in t() are:

array('!url' => \Drupal::url('language.admin_overview'), '!translation-entity' => \Drupal::url('language.content_settings_page'), '!language-help' => \Drupal::url('help.page', array('name' => 'language')))

Can be seen that:
There are three parameters and only two links in the text
The link !language_content_settings_page is not a parameter in the parameters, I think !language_content_settings_page should be replaced by !translation-entity

amitgoyal’s picture

Status:Needs work» Needs review
StatusFileSize
new7.51 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,615 pass(es).
[ View ]

Please review attached patch which will also fix following issue mentioned in #40,

- Language link at Enabling translation section --> FAIL , it doesn't work

@fran seva - You are right that the link !language_content_settings_page is not a parameter in the parameters. But it will be replaced by !url, which will land the user to languages page, rather by !translation-entity.

YesCT’s picture

StatusFileSize
new2.37 KB
new320.45 KB

@amitgoyal thanks.

next time, please also make an interdiff:

For instructions on creating an interdiff, see https://drupal.org/documentation/git/interdiff | Microbranching workflow: http://xjm.drupalgardens.com/blog/interdiffs-how-make-them-and-why-they-...

I made one. :)
Also just for fun, I did a screenshot of git diff --color-words

amitgoyal’s picture

@YesCT - Thanks a lot YesCT for providing the interdiff and colorwords!!

I will definitely provide interdiff next time onward.

jhodgdon’s picture

Thanks for the new patch and interdiff! Can we get a quick manual re-test of just the Enabling section please?

YesCT’s picture

I haven't had a chance to manually check the new wording to see if it matches what people will actually do.
If someone does get to review this, please be on the look out for the word enable. I think we add languages, not enable them.

It might be enough to say a site has to "have" two languages. (instead of say two languages have to be enabled. or even more awkward: has to have added language in addition to the site lanugage.)

jhodgdon’s picture

Status:Needs review» Needs work

+1 on #47.

It looks like we talk about having two languages enabled in the "Enabling translation" uses point, so let's just ay the site needs to have two languages and take out the word "enabled" there.

I don't see any mention of "enabling" languages, so I think we're fine on that.

soipo’s picture

Status:Needs work» Needs review
StatusFileSize
new8.71 KB
new19.52 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,627 pass(es).
[ View ]

Removing 'enabled' after the word language as per comment #48.
Changing the link behind 'the online documentation for the Content Translation module' as the link was broken

fran seva’s picture

@soipo I have downloaded the patch and I have seen that there are to hook_help for content_translation module (see [1]) and the patch should have just one (I think). In other hand, I see there are changes in content_translation_field_info_alter, content_translation_translate_access, content_translation_access, content_translation_form_field_ui_field_edit_form_alter, content_translation_entity_presave and content_translation_language_configuration_element_process and I think that this issue is focus on hook_help.

[1]

+++ b/core/modules/content_translation/content_translation.module
@@ -26,27 +26,38 @@ function content_translation_help($route_name, Request $request) {
     case 'help.page.content_translation':
       $output = '';
       $output .= '<h3>' . t('About') . '</h3>';
-      $output .= '<p>' . t('The Content Translation module allows you to create and manage translations for your Drupal site content. You can specify which elements need to be translated at the content-type level for content items and comments, at the vocabulary level for taxonomy terms, and at the site level for user accounts. Other modules may provide additional elements that can be translated. For more information, see the online handbook entry for <a href="!url">Content Translation</a>.', array('!url' => 'http://drupal.org/documentation/modules/translation_entity')) . '</p>';
+      $output .= '<p>' . t('The Content Translation module allows you to translate content, comments, custom blocks, taxonomy terms, users and other <a href="!entity_help">content entities</a>. Together with the modules <a href="!language">Language</a>, <a href="!config-trans">Configuration Translation</a>, and <a href="!locale">Interface Translation</a>, it allows you to build multilingual websites. For more information, see <a href="!translation-entity">the online documentation for the Content Translation module</a>.', array(
+          '!locale' => (\Drupal::moduleHandler()
+   

and

+

+++ b/core/modules/content_translation/content_translation.module
+@@ -26,27 +26,26 @@ function content_translation_help($route_name, Request $request) {
+     case 'help.page.content_translation':
+       $output = '';
+       $output .= '<h3>' . t('About') . '</h3>';
+-      $output .= '<p>' . t('The Content Translation module allows you to create and manage translations for your Drupal site content. You can specify which elements need to be translated at the content-type level for content items and comments, at the vocabulary level for taxonomy terms, and at the site level for user accounts. Other modules may provide additional elements that can be translated. For more information, see the online handbook entry for <a href="!url">Content Translation</a>.', array('!url' => 'http://drupal.org/documentation/modules/translation_entity')) . '</p>';
++      $output .= '<p>' . t('The Content Translation module allows you to translate content, comments, custom blocks, taxonomy terms, users and other <a href="!entity_help">content entities</a>. Together with the modules <a href="!language">Language</a>, <a href="!config-trans">Configuration Translation</a>, and <a href="!locale">Interface Translation</a>, it allows you to build multilingual websites. For more information, see <a href="!translation-entity">the online documentation for the Content Translation module</a>.', array('!locale' => (\Drupal::moduleHandler()->moduleExists('locale')) ? \Drupal::url('help.page', array('name' => 'locale')) : '#', '!config-trans' => (\Drupal::moduleHandler()->moduleExists('config_translation')) ? \Drupal::url('help.page', array('name' => 'config_translation')) : '#', '!language' => \Drupal::url('help.page', array('name' => 'language')), '!translation-entity' => 'https://drupal.org/documentation/modules/content_translation', '!entity_help' => \Drupal::url('help.page', array('name' => 'entity')))) . '</p>';
+       $output .= '<h3>' . t('Uses') . '</h3>';
+       $output .= '<dl>';
+       $output .= '<dt>' . t(
penyaskito’s picture

Status:Needs review» Needs work

The issue is that he added update-hook-help-content-translation-2091479-43.patch to the repo. It needs to be removed.

fran seva’s picture

StatusFileSize
new16.52 KB
new7.5 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,753 pass(es).
[ View ]

I have removed the update-hook-help-content-translation-2091479-43.patch addition and I have reverted the indentation changes:
- In hook_help: The reason I reverted them is that all hook_helps (almost in locale) introduce the t() attributes in one line.
- In others functions: The reason I reverted them is that there is an issue to make locale module pass Coder Review #1533250: Many coding standards clean-ups in locale module , so this kind of changes shouldn't be done here.

Attach the patch and the interdiff.

fran seva’s picture

Status:Needs work» Needs review
jhodgdon’s picture

Great! I think this is looking really good. We still need a manual test:
- Verify that all the links work
- Verify that all mentions of pages/text/permissions within the UI match what is seen in the UI
- Verify that the formatting is OK.

fran seva’s picture

- Verify that all the links work
All links are working.
The only thing that I have seen is that the link Content Translation page goes to Content Language page. Is that correct? Should be usd the link Content Language instead Content Language?

- Verify that all mentions of pages/text/permissions within the UI match what is seen in the UI.
I have review all page reference and administration page and what it's said is what can be found in the pages.

- Verify that the formatting is OK.
The formatting is correct.

jhodgdon’s picture

Status:Needs review» Needs work

You're right -- the link in
...for the desired content entities on the <a href="!translation-entity">Content Translation</a> page...
should have "Content language" as the link text, not "Content Translation". Note the capitalization as well! That should be a quick fix...

martin107’s picture

StatusFileSize
new7.49 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,738 pass(es).
[ View ]
new2.32 KB

The quick fix.

martin107’s picture

Status:Needs work» Needs review
jhodgdon’s picture

Component:content_translation.module» documentation
Status:Needs review» Reviewed & tested by the community

Looks good! This has already been manually tested, and the one problem found has been fixed, so I think it's RTBC now.

mparker17’s picture

Assigned:batigolix» Unassigned
jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed

Thanks again everyone! Committed to 8.x.

YesCT’s picture

#22 took out the bit about permissions. I opened #2287415: Include permissions in hook_help for content_translation module let's try setting up translation for a user that isn't user 1 and discuss there if we should add something to the help.

also note since the example standard for module help uses content translation (and permissions), #2286351: Update help text standard regarding permission

Status:Fixed» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.