Skip to content

Commit b77fb90

Browse files
authored
reinstate 2024 sr1 docs and add beta link (#276)
1 parent 9a9e11f commit b77fb90

6 files changed

Lines changed: 241 additions & 90 deletions

File tree

.github/workflows/release.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ jobs:
2222

2323
env:
2424
ProductName: 'Trados Studio'
25-
ProductNameWithEdition: 'Trados Studio 2026 Release'
26-
ProductVersion: Studio19
27-
VersionNumber: 19
25+
ProductNameWithEdition: 'Trados Studio 2024 SR1'
26+
ProductVersion: Studio18
27+
VersionNumber: 18
2828
VisualStudioEdition: 'Microsoft Visual Studio 2022'
29-
PluginPackedPath : '%AppData%\Trados\Trados Studio\19\Plugins\Packages\'
30-
PluginUnpackedPath: '%AppData%\Trados\Trados Studio\19\Plugins\Unpacked\'
31-
InstallationFolder: 'C:\Program Files (x86)\Trados\Trados Studio\Studio19'
32-
DefaultProjectsFolder: 'C:\Users\UserName\Documents\Studio 2026 Release\Projects'
33-
StudioDocumentsFolderName: 'Studio 2026 Release'
29+
PluginPackedPath : '%AppData%\Trados\Trados Studio\18\Plugins\Packages\'
30+
PluginUnpackedPath: '%AppData%\Trados\Trados Studio\18\Plugins\Unpacked\'
31+
InstallationFolder: 'C:\Program Files (x86)\Trados\Trados Studio\Studio18'
32+
DefaultProjectsFolder: 'C:\Users\UserName\Documents\Studio 2024\Projects'
33+
StudioDocumentsFolderName: 'Studio 2024'
3434
AppSigningEmail : app-signing@sdl.com
3535
ServerProductName: Trados GroupShare
3636
ServerProductNameWithVersion: Trados GroupShare 2020 SR1
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# How to update plugins to Trados Studio 2024
2+
3+
The following are a list of changes and known issues to consider when updating your plugin to be compatible with Trados Studio 2024.
4+
5+
## Plugin Framework
6+
The latest version of the plugin framework packages should be installed. You can add/update the plugin framework nuget packages in your project via the package manager user interface or console.
7+
### Package Manager UI
8+
* In **Solution Explorer**, right-click **References** and choose **Manage NuGet Packages**.
9+
* Select nuget.org as the **Package source**.
10+
* Search for `Sdl.Core.PluginFramework` from the **Browse** tab.
11+
* Select the package from the list and click **Install** or **Update**.
12+
* `Sdl.Core.PluginFramework`, version _2.1.0_
13+
* `Sdl.Core.PluginFramework.Build`, version _18.0.1_
14+
* Accept any license prompts to finnish the installation.
15+
16+
<br/>
17+
18+
## Plugin Manifest
19+
20+
The manifest file **pluginpackage.manifest.xml** is located at the root of your project solution. The values of the **RequiredProduct** should be updated to align with the latest release.
21+
22+
### RequiredProduct
23+
24+
- Min version should be set to: 18.0.
25+
- Max version should be set to 18.9. It is recommended to also set this value, as it will provide the AppStore with sufficient information in correctly identifying plugins that are compatible with the version of Trados Studio that is launched.
26+
- Name should be set to: *TradosStudio*
27+
28+
Example
29+
```xml
30+
<?xml version="1.0" encoding="utf-8"?>
31+
<PluginPackage xmlns="http://www.sdl.com/Plugins/PluginPackage/1.0">
32+
<PlugInName>My plugin name</PlugInName>
33+
<Version>1.1.0.0</Version>
34+
<Description>My plugin description</Description>
35+
<Author>Trados AppStore Team</Author>
36+
<RequiredProduct name="TradosStudio" minversion="18.0" maxversion="18.9" />
37+
</PluginPackage>
38+
```
39+
40+
## Project References & Deployment Path
41+
The references in the project file (.csproj) should be mapped to the new installation path for Trados Studio 2024. Make reference to the following examples for both the production and beta releases.
42+
43+
### [Production](#tab/standard)
44+
45+
Installation path: *$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio18*:
46+
~~~xml
47+
<Reference Include="Sdl.Desktop.IntegrationApi.Extensions">
48+
<HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio18\Sdl.Desktop.IntegrationApi.Extensions.dll</HintPath>
49+
</Reference>
50+
~~~
51+
<br/>
52+
53+
Plugin deployment path: *$(AppData)\Trados\Trados Studio\18\Plugins*:
54+
~~~xml
55+
<PluginDeploymentPath>$(AppData)\Trados\Trados Studio\18\Plugins</PluginDeploymentPath>
56+
~~~
57+
58+
### [BETA](#tab/beta)
59+
60+
Installation path: *$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio18Beta*:
61+
~~~xml
62+
<Reference Include="Sdl.Desktop.IntegrationApi.Extensions">
63+
<HintPath>$(MSBuildProgramFiles32)\Trados\Trados Studio\Studio18Beta\Sdl.Desktop.IntegrationApi.Extensions.dll</HintPath>
64+
</Reference>
65+
~~~
66+
<br/>
67+
68+
Plugin deployment path: *$(AppData)\Trados\Trados Studio\18Beta\Plugins*:
69+
~~~xml
70+
<PluginDeploymentPath>$(AppData)\Trados\Trados Studio\18Beta\Plugins</PluginDeploymentPath>
71+
~~~
72+
73+
---
74+
75+
> [!NOTE]
76+
>
77+
> To update settings directly in the project file from Visual Studio
78+
> * Right-click on the project node in the **Solution Explorer** and select **Unload Project**.
79+
> * Then, right-click on the project and choose **Edit** <projectname>
80+
>
81+
> Once you have applied your changes in the project file, then reload project
82+
> * In the **Solution Explorer**, select the projects you want to load (press **Ctrl** while clicking to select more than one project)
83+
> * Then right-click on the project and choose **Reload Project**.
84+
85+
<br/>
86+
<br/>
87+
88+
## Known Issues
89+
The following are a list of known issues and solutions that you might encounter depending on your settings and configuration:
90+
91+
### Trados.Community.Toolkit (formally SDL.Community.Toolkit)
92+
A new version of the Trados Community Toolkit, version 5.0.1, has been released to support the latest version of Trados Studio 2024. This includes the following assemblies:
93+
94+
- [Trados.Community.Toolkit.Core](https://www.nuget.org/packages/Trados.Community.Toolkit.Core)
95+
- [Trados.Community.Toolkit.LanguagePlatform](https://www.nuget.org/packages/Trados.Community.Toolkit.LanguagePlatform)
96+
- [Trados.Community.Toolkit.Integration](https://www.nuget.org/packages/Trados.Community.Toolkit.Integration)
97+
- [Trados.Community.Toolkit.FileType](https://www.nuget.org/packages/Trados.Community.Toolkit.FileType)
98+
- [Trados.Community.Toolkit.ProjectAutomation](https://www.nuget.org/packages/Trados.Community.Toolkit.ProjectAutomation)
99+
100+
### Dependency version changes
101+
There is a list of known dependency version changes that may influence your integration with the latest Trados Studio 2024 APIs; this is typically seen from standalone applications that are running outside of the Trados Studio context. To resolve these references, include the following binding redirects in the configuration file of the project.
102+
103+
``` xml
104+
<?xml version="1.0" encoding="utf-8" ?>
105+
<configuration>
106+
<startup>
107+
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
108+
</startup>
109+
<runtime>
110+
<NetFx40_PInvokeStackResilience enabled="1" />
111+
<legacyCorruptedStateExceptionsPolicy enabled="true" />
112+
<ThrowUnobservedTaskException enabled="true" />
113+
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
114+
<dependentAssembly>
115+
<assemblyIdentity name="Microsoft.Extensions.DependencyModel" publicKeyToken="adb9793829ddae60" culture="neutral" />
116+
<bindingRedirect oldVersion="0.0.0.0-7.0.0.0" newVersion="7.0.0.0" />
117+
</dependentAssembly>
118+
</assemblyBinding>
119+
</runtime>
120+
</configuration>
121+
```

0 commit comments

Comments
 (0)