CiviCRM Community Forums (archive)

erm, well it is on the list...

Here is a start at User interface text standards: http://wiki.civicrm.org/confluence/display/CRM/User+interface+text

I also started collecting legacy interface guidelines here: http://wiki.civicrm.org/confluence/display/CRM/Legacy+interface+standard+pages

It is ripped off from https://www.drupal.org/node/604342.

please avoid massively renaming existing strings (this will really annoy translators).

Well Choosing sentence case over Title Case would do that, right? I do think it is a lot nicer but that's only me, and if there is no way to do it automatically, and it is really going to annoy translators, then maybe we should leave.

If you want to take a quick look over what I have done and add stuff from this forum that you think is useful, that would be cool.

Here is a start at User interface text standards: http://wiki.civicrm.org/confluence/display/CRM/User+interface+text

Cool. A lot of these are good-points. Added some comments.

Quote

please avoid massively renaming existing strings (this will really annoy translators).

Well Choosing sentence case over Title Case would do that, right? I do think it is a lot nicer but that's only me, and if there is no way to do it automatically, and it is really going to annoy translators, then maybe we should leave.

Agree we shouldn't change things on a whim. But it seems like this would be a common enough problem ... that someone would have written a re-keying mechanism for use when the English-language string changes in trivial ways ...

The best I can think of would be to do some kind of PR-level testing to report on what new strings are being introduced by each commit (and ideally put up a red flag if they are very similar to any existing string). But I'm not really sure how to implement that either...

Trying to break that down into smaller questions...

• What's the baseline? -- The tool should report "new" strings, but compared to what? We could compare to "the current official code in the target branch" or "the strings in the last release" or "the strings currently known to Transifex" or "all of the above".
• How to report? -- It's straight-forward to add a new item to the Jenkins navbar (e.g. like "CiviBuild" in https://test.civicrm.org/job/CiviCRM-Core-Matrix/CIVIVER=4.4,label=test-debian6-1/433/ ) or to mark a build as *failed* (red). It's a bit more involved to display detailed messages in Github's UI.

Regarding PHPUnit -- suppose we had a rule like "strings must not include markup." A simple unit test might look like this (pseudocode):

class StringConformanceTest {
  function testNoMarkup() {
    system("bin/extract-strings > /tmp/all-strings.txt");
    foreach (read("/tmp/all-strings.txt") as $string) {
      $this->assertFalse(containsMarkup($string));
    }
  }
}

If one wanted to run the same test but focus only on changed files, then maybe pseudocode like:

$ git diff $targetBranch..HEAD > /tmp/changes.diff
$ env DIFF=/tmp/changes.diff ./scripts/phpunit StringConformanceTest

class StringConformanceTest {
  function testNoMarkup() {
    if ($diffFile = getenv('DIFF')) {
      system("bin/extract-strings $diffFile > /tmp/all-strings.txt");
    } else {
      system("bin/extract-strings > /tmp/all-strings.txt");
    }
    foreach (read("/tmp/all-strings.txt") as $string) {
      $this->assertFalse(containsMarkup($string));
    }
  }
}