Skip to content

Update generated documentation #283

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.

Sign up for GitHub

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

Open
github-actions wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Update generated documentation #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 131 additions & 24 deletions articles/hints_tips/Update_Plugins/how_to_update_plugins_to_trados_studio_2024_sr1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,40 +160,147 @@ <h5>Note</h5>
<h2 id="known-issues--dependency-updates">Known Issues &amp; Dependency Updates</h2>
<h3 id="dependency-version-changes">Dependency Version Changes</h3>
<p>Standalone integrations may require binding redirects. Example for <code>App.config</code>:</p>
<pre><code class="lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?&gt;
<pre><code class="lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
&lt;configuration&gt;
&lt;configSections&gt;
&lt;section name=&quot;BestMatchServiceUrlsConfig&quot; type=&quot;Sdl.BestMatchServiceStudioIntegration.Common.UrlsConfig, Sdl.BestMatchServiceStudioIntegration.Common&quot; /&gt;
&lt;section name=&quot;log4net&quot; type=&quot;log4net.Config.Log4NetConfigurationSectionHandler, log4net&quot; /&gt;
&lt;/configSections&gt;
&lt;BestMatchServiceUrlsConfig GlobalApi=&quot;https://api.cloud.trados.com&quot; auth0=&quot;https://sdl-prod.eu.auth0.com&quot;&gt;
&lt;LanguageConfig&gt;
&lt;Lang Code=&quot;en&quot; /&gt;
&lt;Lang Code=&quot;de&quot; /&gt;
&lt;Lang Code=&quot;fr&quot; /&gt;
&lt;Lang Code=&quot;es&quot; /&gt;
&lt;Lang Code=&quot;ja&quot; /&gt;
&lt;Lang Code=&quot;it&quot; /&gt;
&lt;Lang Code=&quot;zh-CN&quot; /&gt;
&lt;/LanguageConfig&gt;
&lt;HavingTroubleSigningIn url=&quot;https://gateway.sdl.com/apex/communityknowledge?articleName=000001399&quot; /&gt;
&lt;/BestMatchServiceUrlsConfig&gt;
&lt;startup useLegacyV2RuntimeActivationPolicy=&quot;true&quot;&gt;
&lt;supportedRuntime version=&quot;v4.0&quot; sku=&quot;.NETFramework,Version=v4.8&quot; /&gt;
&lt;/startup&gt;

&lt;runtime&gt;
&lt;NetFx40_PInvokeStackResilience enabled=&quot;1&quot; /&gt;
&lt;legacyCorruptedStateExceptionsPolicy enabled=&quot;true&quot; /&gt;
&lt;ThrowUnobservedTaskException enabled=&quot;true&quot; /&gt;
&lt;assemblyBinding xmlns=&quot;urn:schemas-microsoft-com:asm.v1&quot;&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Extensions.DependencyModel&quot; publicKeyToken=&quot;adb9793829ddae60&quot; culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-7.0.0.0&quot; newVersion=&quot;7.0.0.0&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Memory&quot;
publicKeyToken=&quot;cc7b13ffcd2ddd51&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-4.0.1.2&quot;
newVersion=&quot;4.0.1.2&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Runtime.CompilerServices.Unsafe&quot;
publicKeyToken=&quot;b03f5f7f11d50a3a&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-65535.65535.65535.65535&quot;
newVersion=&quot;6.0.0.0&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Extensions.Logging&quot;
publicKeyToken=&quot;adb9793829ddae60&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-65535.65535.65535.65535&quot;
newVersion=&quot;8.0.0.0&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Extensions.Logging.Abstractions&quot;
publicKeyToken=&quot;adb9793829ddae60&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-65535.65535.65535.65535&quot;
newVersion=&quot;8.0.0.2&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Extensions.Options&quot;
publicKeyToken=&quot;adb9793829ddae60&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-65535.65535.65535.65535&quot;
newVersion=&quot;8.0.0.2&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Collections.Immutable&quot;
publicKeyToken=&quot;b03f5f7f11d50a3a&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-65535.65535.65535.65535&quot;
newVersion=&quot;8.0.0.0&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Text.Encoding.CodePages&quot;
publicKeyToken=&quot;b03f5f7f11d50a3a&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-65535.65535.65535.65535&quot;
newVersion=&quot;8.0.0.0&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Threading.Tasks.Extensions&quot;
publicKeyToken=&quot;cc7b13ffcd2ddd51&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-4.2.0.1&quot;
newVersion=&quot;4.2.0.1&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Text.Json&quot;
publicKeyToken=&quot;cc7b13ffcd2ddd51&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-8.0.0.6&quot;
newVersion=&quot;8.0.0.6&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Bcl.AsyncInterfaces&quot;
publicKeyToken=&quot;cc7b13ffcd2ddd51&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-8.0.0.0&quot;
newVersion=&quot;8.0.0.0&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;System.Diagnostics.DiagnosticSource&quot;
publicKeyToken=&quot;cc7b13ffcd2ddd51&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-8.0.0.1&quot;
newVersion=&quot;8.0.0.1&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Extensions.DependencyInjection.Abstractions&quot;
publicKeyToken=&quot;adb9793829ddae60&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-8.0.0.2&quot;
newVersion=&quot;8.0.0.2&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;dependentAssembly&gt;
&lt;assemblyIdentity name=&quot;Microsoft.Extensions.DependencyInjection&quot;
publicKeyToken=&quot;adb9793829ddae60&quot;
culture=&quot;neutral&quot; /&gt;
&lt;bindingRedirect oldVersion=&quot;0.0.0.0-8.0.0.0&quot;
newVersion=&quot;8.0.0.1&quot; /&gt;
&lt;/dependentAssembly&gt;
&lt;/assemblyBinding&gt;
&lt;/runtime&gt;
&lt;startup&gt;
&lt;supportedRuntime version=&quot;v4.0&quot; sku=&quot;.NETFramework,Version=v4.8&quot; /&gt;
&lt;/startup&gt;

&lt;log4net&gt;
&lt;!-- Set levels to DEBUG for extended logging information --&gt;
&lt;appender name=&quot;RollingFile&quot; type=&quot;Sdl.Desktop.Logger.LocalUserAppDataFileAppender, Sdl.Desktop.Logger&quot;&gt;
&lt;/appender&gt;
&lt;!-- output to debug string --&gt;
&lt;appender name=&quot;OutputDebug&quot; type=&quot;log4net.Appender.OutputDebugStringAppender&quot;&gt;
&lt;layout type=&quot;log4net.Layout.PatternLayout&quot;&gt;
&lt;conversionPattern value=&quot;%date [%thread] %-5level %logger [%property{NDC}] - %message%newline&quot; /&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;root&gt;
&lt;level value=&quot;INFO&quot; /&gt;
&lt;appender-ref ref=&quot;RollingFile&quot; /&gt;
&lt;appender-ref ref=&quot;OutputDebug&quot; /&gt;
&lt;/root&gt;
&lt;logger name=&quot;Sdl.TranslationStudio&quot;&gt;
&lt;level value=&quot;INFO&quot; /&gt;
&lt;/logger&gt;
&lt;logger name=&quot;Sdl.Desktop&quot;&gt;
&lt;level value=&quot;INFO&quot; /&gt;
&lt;/logger&gt;
&lt;logger name=&quot;Sdl.ProjectApi&quot;&gt;
&lt;level value=&quot;INFO&quot; /&gt;
&lt;/logger&gt;
&lt;logger name=&quot;Licensing&quot;&gt;
&lt;level value=&quot;INFO&quot; /&gt;
&lt;/logger&gt;
&lt;!--&lt;logger name=&quot;Sdl.MultiTerm&quot;&gt;
&lt;level value=&quot;DEBUG&quot;/&gt;
&lt;/logger&gt;--&gt;
&lt;/log4net&gt;
&lt;/configuration&gt;
</code></pre>
<br>
<p>In most cases, this will be sufficient to enable proper interaction with the Studio APIs.</p>
<p>If the application still fails to work as expected, an alternative approach is to copy the entire configuration from the Trados Studio executable configuration file (<code>SdlTradosStudio.exe.config</code>) into your application's <code>app.config</code>. This ensures that all necessary runtime and binding settings are aligned with those expected by Studio.
<br></p>
<h2 id="breaking-api-changes">Breaking API Changes</h2>
<h3 id="assembly-version-change-requires-recompilation">Assembly Version Change Requires Recompilation</h3>
<p>With Trados Studio 2024 SR1, all core Trados assemblies have had their <strong>assembly version increased to 18.1.x.x</strong> (reflecting the semantic versioning minor update). <strong>This assembly version bump introduces a breaking change:</strong> Any plugin or standalone tool that references Trados assemblies must be recompiled against the new release, even if no other code changes are required. Referencing outdated assemblies is not supported and will likely result in runtime failures due to version mismatches.<br>
Expand Down
Loading