Skip to content

C76762: Removing all "\" at the end of lines and adding two spaces in… #11541

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

Merged
merged 3 commits into from
Apr 2, 2019

Conversation

v-makoud
Copy link
Contributor

…stead

Localization team has reported source content issue that causes localized version to have broken/different format compared to en-us version.

Summary

Describe your changes here.

Fixes #Issue_Number (if available)

…stead

Localization team has reported source content issue that causes localized version to have broken/different format compared to en-us version.
@v-makoud v-makoud requested a review from Lxiamail as a code owner March 28, 2019 11:31
@v-makoud
Copy link
Contributor Author

#sign-off

@mairaw
Copy link
Contributor

mairaw commented Mar 28, 2019

I'd like to understand why we're doing this @v-makoud. Is this breaking for Loc?
As I said in the other PR, we don't want to add the two spaces back in the end because some editors will trim white spaces automatically when saving a file.

/cc @JasonCard

@mairaw mairaw added the loc Indicates issues that are about localized content [org][type][category] label Mar 28, 2019
@mairaw mairaw removed the request for review from Lxiamail March 28, 2019 15:32
@v-maudel
Copy link
Contributor

Hi @mairaw , these strings as they are, are breaking the localized content. Bill wagner proposed a fix here and I also left a comment. #11515

regards.

@mairaw
Copy link
Contributor

mairaw commented Mar 28, 2019

Ah sorry, missed the reply there and couldn't find that PR this morning.

Yes, his solution to code fence is a good workaround. Eventually, I'd like to fix all those sections to add the links and formatting as we used to have in MSDN back in the day like we did here:
https://raw.githubusercontent.com/dotnet/docs/master/docs/framework/configure-apps/file-schema/runtime/index.md

For that, I guess we'd have to use explicit <br /> tags. This is related to this discussion: MicrosoftDocs/feedback#1264

I'll have to review all the uses of that \ at the end of a line because we have other places we've been using that.

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

Can you use the ``` syntax here then @v-makoud? It would be preferable vs. adding spaces.

If this could match what we had on MSDN before (indentation and node names, except the last one shouldn't say element), even better:
image

@mairaw mairaw added this to the March 2019 milestone Mar 29, 2019
@v-makoud
Copy link
Contributor Author

v-makoud commented Apr 2, 2019

@mairaw yes we can use this.

@mairaw mairaw merged commit ed379a1 into dotnet:master Apr 2, 2019
@nemrism
Copy link
Contributor

nemrism commented Sep 6, 2019

Too bad I didn't read this thread before pushing the PRs to solve #2038 & #2149 issues and especially the #14150 PR which changes this specific file!
I did use a \ in most or every files I've changed... how/when could I check if it breaks the localization of those pages?

/cc @mairaw / @v-makoud / @v-maudel

@JasonCard
Copy link
Contributor

@nemrism Those affected files under subfolder https://github.com/dotnet/docs/blob/live/docs/framework/configure-apps/ are machine translated and should be localized by Monday morning. Then you can check how it's displayed in live page.
cc @mairaw @v-makoud @v-maudel

@nemrism
Copy link
Contributor

nemrism commented Sep 7, 2019

Thanks @JasonCard

I already see some issues with the automated translation, here:
https://docs.microsoft.com/fr-fr/dotnet/framework/configure-apps/file-schema/wcf/issuerchannelbehaviors-element

Some elements get translated which is something incorrect as configuration file schema is not meant to be translated.

Is there a way to tell the automatic translation to avoid this?
It already seems to ignore the <add> child element tag but translate other tags in the hierarchy at the top of the article... due to the bold formatting?

@JasonCard
Copy link
Contributor

JasonCard commented Sep 9, 2019

@nemrism Thank you for checking.
Code block syntax can be used to block text from getting localized.
For example, words surrounded by backtick quotes (`) become code block and will not be localized like <clientCredentials>.
And as fixed in this PR, if you can block multiple lines from localization by surrounding the section with 3 backtick quotes (```) to make them a code block.
Text between <> brackets are being localized according to translation memory and/or machine translation.

@mairaw
Copy link
Contributor

mairaw commented Sep 9, 2019

Let me test something else with the no-loc feature @nemrism.

@JasonCard but there was also a question about being able to use \ as the new line at the end of sentences. We got some PRs from the loc team telling us that this would cause issues for Loc.

Related discussion: MicrosoftDocs/feedback#1264

@nemrism
Copy link
Contributor

nemrism commented Sep 10, 2019

Actually @JasonCard, there is already another paragraph using code block to present the syntax of the configuration files XML.

The goal of the lines at the beginning of the article, the ones you can see in the screenshot, is to respect the hierarchy while linking to the pages of the parent elements.

So we should find a solution to have them presented like this, with links on almost each lines. And the best solution would also allow us to tell the automatic translation to leave those links not translated.

Thanks @mairaw, I'll wait for your feedback.

@JasonCard
Copy link
Contributor

@mairaw @nemrism I see, yes, the no-loc feature can also be used to block text from localization.
Regarding the use of \ as new line at the end of sentences, I'm not sure why it was causing issue for loc, but it seems to be working now in this page, so we just need to block the text from localization by adding the no-loc syntax.

@nemrism
Copy link
Contributor

nemrism commented Sep 10, 2019

Thanks, I'll check the documentation of the no-loc if I can find some. Or will wait for @mairaw's sample/test results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
loc Indicates issues that are about localized content [org][type][category]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants