Extract help topics label from meta tag in Twig files

I just realized the issue summary has a link to POTX code around YAML files, and we're not using YAML, so we don't need to worry about that. The Twig files will be found and parsed. So, really the only question is about the discovery of the meta tags.

Currently our Twig files look like this:

<meta name="help_topic:label" content="Writing good help"/>
<meta name="help_topic:top_level"/>
<p>{% trans %}Here are some suggestions for how to make your help topics as useful as possible for readers:{% endtrans %}</p>
...

So once one of these Twig files is found, anything in the trans tags will be translated.

The problem is that the help topic title also needs to be translated, which is in that meta tag. So we will need to patch POTX so that this is parsed.

Twig file parsing is done in _potx_parse_twig_file(), which is here:
https://git.drupalcode.org/project/potx/blob/HEAD/potx.inc#L1766
I'm going to move this issue over to the POTX project so that we can modify that function and make sure the meta tag for the help topic label is also parsed as translatable.

Here is the test that we need to have pass, in order to resolve this issue. No code change yet, so I expect the test to fail.

Good, that failed as expected. Here's a patch for the code... I added two more lines for testing.

The patch test failed with a CI error, in this line of the test running script:

++ docker pull drupalci/php-5.6-apache:production
14:01:30 production: Pulling from drupalci/php-5.6-apache

It seems to have timed out. I added a new test. I don't think the fail is at all related to the patch.

OK, the tests passed this time. It's a pretty small change. Thoughts?

Unassigning for the UI followup.

The format for meta-data for Twig help topics has changed, so I created #3086657: Parse new front-matter format for help topic titles

This issue is still open for some UI issue I think? Should that be spun off to a separate issue?

The patch for the original format was already committed, and then this issue got sidetracked for an unrelated UI issue that should probably be on its own issue but isn't.

The issue to use the new format is shown in #22 #3086657: Parse new front-matter format for help topic titles, which lists this one as related, and is currently postponed until we get the Front Matter component into Core.

Right, but not on this issue. We should move over to #3086657: Parse new front-matter format for help topic titles. This one got derailed on some UI issue.

I propose that you back out the commits that were made on this issue, and which caused problems, unless someone else needs this type of format for text.

We have a separate issue for the new front matter format for help topics, on
#3086657: Parse new front-matter format for help topic titles
which is waiting for the front matter component to be added to Drupal core.

Again, this is not the front matter issue. The front matter issue for POTX is
#3086657: Parse new front-matter format for help topic titles

I'm going to go take this issue out of the Roadmap for Help Topics, because it is no longer relevant. Also changing title.

Also I am orphaning this issue. No longer related to help topics.

I don't think anyone is using this code for getting meta tags as translatable from Twig templates.

Extracting data from front matter is a separate issue:
#3086657: Parse new front-matter format for help topic titles
which is currently postponed until Front Matter is committed to core as part of Twig.

This looks very straightforward and the tests pass.

There is a coding standards message on the test results page that should be fixed.

I still think this patch should be put on #3086657: Parse new front-matter format for help topic titles instead, but we can leave that up to the POTX maintainers I guess.

The coding standards linter runs on any file that is patched, and shows all messages in that file. It is not aware of which lines are new and which are old. It does tell you that the file has N more coding standards messages than the previous version.

I took a more careful look at the code. One comment seems wrong:

+        if (in_array($key, $keys_to_save, TRUE)) {
+          // Only label defined translatable.

Since $keys_to_save is defined above, I think we should leave that comment out. If someone decides we need to translate additional front matter later on, they would change the array up above and not fix this comment that is not with that array.

Other than removing that one line, I think this is good.

I took a careful look at the 7.x and 8.x patches, and I think they are both ready to go. With tests!