Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Security Assistant Field Order #343

Open
wants to merge 1 commit into
base: stable
Choose a base branch
from
Open

Conversation

flywire
Copy link
Contributor

@flywire flywire commented Sep 23, 2024

Describe fields in same order as form

Replaces #342

Describe fields in same order as form
Copy link
Member

@fellen fellen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not only the order changed:

  • This labels were also renamed to remove ambiguity.

  • Also the colons were removed from the labels — in the whole dialog.

  • I wonder, if you could also insert a screenshot like in the german version

  • and perhaps apply the new style with <gloss*> instead of <emphasis role="bold">?

@@ -5457,6 +5457,21 @@
</para>

<itemizedlist>
<listitem>
<para><emphasis role="bold">Name:</emphasis> The full name of the commodity is a recognizable name such as
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<emphasis role="bold">Full name</emphasis>

</listitem>

<listitem>
<para><emphasis role="bold">Symbol:</emphasis> Indicates the symbol or abbreviation for the commodity.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<emphasis role="bold">Symbol/abbreviation</emphasis>

@flywire
Copy link
Contributor Author

flywire commented Sep 23, 2024

Not only the order changed:

But it's complicated and I suppose ultimately this PR will be closed without merging.

  • This labels were also renamed to remove ambiguity.

How about a critique?

  • Display would be clearer than Display symbol to remove confusion with Symbol/abbreviation, the tooltip has the details (which btw doesn't refer to Symbol/abbreviation).
  • Namespace means Namespace apparently from dev response on mail list. It's not in any English dictionary and after a web search it won't be any clearer. Type (or even category) was very clear. I'm not sure what is built-in either.
  • Also the colons were removed from the labels — in the whole dialog.

Doesn't seem relevant to this section which has a consistent style with the rest of the document.

  • I wonder, if you could also insert a screenshot like in the german version

Screenshots from random version/OSs look scrappy (English version).

  • and perhaps apply the new style with <gloss*> instead of <emphasis role="bold">?

Isn't this something that could be scripted in the repo across all docs/languages? This is one of the downsides of complicated markup compared to something like markdown.

@fellen
Copy link
Member

fellen commented Sep 24, 2024

@CWehli missed I your backport of ch_Tools_Assistants.docbook or have you aready something prepared?

@fellen
Copy link
Member

fellen commented Sep 24, 2024

How about a critique?

We try to avoid renaming english terms because over 60 translators of the program and the documenters have to apply the change, too.

@fellen
Copy link
Member

fellen commented Sep 24, 2024

  • Namespace

Right, Google translate would understand name space, but not namespace. @jralls perhaps to fix after the string freeze is lifted?

@jralls
Copy link
Member

jralls commented Sep 24, 2024

Right, Google translate would understand name space, but not namespace. @jralls perhaps to fix after the string freeze is lifted?

Well, Google translate would understand "name" and "space" but that wouldn't necessarily convey the same meaning. After all "namespace" is computer science jargon so it's not going to be meaningful to normal people anyway. I think "type" is a bit too restrictive, how about "Commodity Group"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants