Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,13 @@ <h3 id="getting-started-with-your-contribution">Getting started with your contri
</li>
<li><p>Our documentation automatically fills in the product name and other details so you don't have to make the changes manually if we decide to update the product name. Use the '<a href="var:VariableName">var:VariableName</a>' construct to tell our documentation engine to fill in the info for you. Here are the constructs available at this point:</p>
<pre><code>Trados Studio - The product name, for example Trados Studio
Trados Studio 2024 SR1 - The official product release name including the edition, for example 'Trados Studio 2021'
Studio18 - the official product version, for example Studio16
18 - the official product version number, such as 16
Trados Studio 2026 Release - The official product release name including the edition, for example 'Trados Studio 2021'
Studio19 - the official product version, for example Studio16
19 - the official product version number, such as 16
Microsoft Visual Studio 2022 - the most recent development compatible Microsoft Visual Studio edition
%AppData%\Trados\Trados Studio\18\Plugins\Packages\ - the location where plugins are deployed, for example '%AppData%\Roaming\SDL\SDL Trados Studio\16\Plugins\Packages\'
%AppData%\Trados\Trados Studio\18\Plugins\Unpacked\ - the location where plugins are unpacked, for example '%AppData%\Roaming\SDL\SDL Trados Studio\16\Plugins\Unpacked\'
C:\Program Files (x86)\Trados\Trados Studio\Studio18 - the current installation folder of our product, for example 'C:\Program Files\SDL\SDL Trados Studio\Studio16\'
%AppData%\Trados\Trados Studio\19\Plugins\Packages\ - the location where plugins are deployed, for example '%AppData%\Roaming\SDL\SDL Trados Studio\16\Plugins\Packages\'
%AppData%\Trados\Trados Studio\19\Plugins\Unpacked\ - the location where plugins are unpacked, for example '%AppData%\Roaming\SDL\SDL Trados Studio\16\Plugins\Unpacked\'
C:\Program Files (x86)\Trados\Trados Studio\Studio19 - the current installation folder of our product, for example 'C:\Program Files\SDL\SDL Trados Studio\Studio16\'
</code></pre>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ <h5>Note</h5>
</code></pre></section>
</div>
<h2 id="the-plug-in-build-folder">The Plug-in Build Folder</h2>
<p>Make sure that you sign your assembly. Then build the assembly. The project is automatically configured to build the plug-in file into the folder: <em> %AppData%\Trados\Trados Studio\18\Plugins\Packages\ </em>. After you have built the plug-in, you should find the file <em>Custom Batch Task1.sdlplugin</em>. Now start Trados Studio. Because the plug-in is not yet officially signed by RWS, you will see the following message after you start the application:
<p>Make sure that you sign your assembly. Then build the assembly. The project is automatically configured to build the plug-in file into the folder: <em> %AppData%\Trados\Trados Studio\19\Plugins\Packages\ </em>. After you have built the plug-in, you should find the file <em>Custom Batch Task1.sdlplugin</em>. Now start Trados Studio. Because the plug-in is not yet officially signed by RWS, you will see the following message after you start the application:
<img style="display:block; " src="images/Plugin_NotSigned.jpg">
For the moment, ignore this message. Click <strong>Yes</strong> to make sure that Trados Studio extracts the plug-in file. Once Studio is started, you should find the sub-folder <em>Custom Batch Task1</em> under <em> %AppData%\Trados\Trados Studio\18\Plugins\Unpacked\ </em>. This sub-folder contains the unpacked plug-in assemblies.</p>
For the moment, ignore this message. Click <strong>Yes</strong> to make sure that Trados Studio extracts the plug-in file. Once Studio is started, you should find the sub-folder <em>Custom Batch Task1</em> under <em> %AppData%\Trados\Trados Studio\19\Plugins\Unpacked\ </em>. This sub-folder contains the unpacked plug-in assemblies.</p>
<p>In the batch tasks list of Trados Studio, you will see the name of your newly compiled plug-in:
<img style="display:block; " src="images/SampleTaskName.jpg"></p>
<p>When you select your sample batch task you will see the following window with the plug-in description:
Expand Down
2 changes: 1 addition & 1 deletion apiconcepts/core/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h1 id="plug-in-framework-overview">Plug-in Framework Overview</h1>

<p>This help system describes the Plug-in Framework. This framework offers plug-in functionality to applications and components. Application developers can define extension points and dynamically load any plug-ins providing extensions targeting these extension points using the plug-in framework.</p>
<h2 id="version">Version</h2>
<p>The version of the Plug-in Framework documented here is the one that was released with Trados Studio 2024 SR1.</p>
<p>The version of the Plug-in Framework documented here is the one that was released with Trados Studio 2026 Release.</p>
<h2 id="main-concepts-and-definitions">Main Concepts and Definitions</h2>
<p>This section introduces a number of concepts and definitions that are central to the plug-in framework.</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion apiconcepts/core/the_plugin_manifest_generator.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h2 id="plug-in-manifest-generator">Plug-in Manifest Generator</h2>
<p>When creating a plug-in project using the project template from the SDK, the project file will contain the following pieces of custom content:</p>
<ul>
<li><code>CreatePluginPackage</code> - if set to true will generate the <code>*.sdlplugin</code></li>
<li><code>PluginDeploymentPath</code> - path to the root folder where the <code>Packages</code> and <code>Unpacked</code> folders are present, default path is set to <em>%AppData%\Trados\Trados Studio\18\Plugins\Packages\</em></li>
<li><code>PluginDeploymentPath</code> - path to the root folder where the <code>Packages</code> and <code>Unpacked</code> folders are present, default path is set to <em>%AppData%\Trados\Trados Studio\19\Plugins\Packages\</em></li>
</ul>

</article>
Expand Down
8 changes: 4 additions & 4 deletions apiconcepts/filetypesupport/build_the_file_type_plug_in.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,11 @@ <h2 id="the-plug-in-package-path">The Plug-in Package Path</h2>
<p>In order for Trados Studio to pick up the plug-in package and to extract it, the following folders need to be available on your hard drive:</p>
<p><strong>For Windows 10\ Windows 7\ Windows 8</strong>:</p>
<ul>
<li>%AppData%\Trados\Trados Studio\18\Plugins\Packages\ *</li>
<li>%AppData%\Trados\Trados Studio\19\Plugins\Packages\ *</li>
</ul>
<p>and</p>
<ul>
<li>%AppData%\Trados\Trados Studio\18\Plugins\Unpacked\ *</li>
<li>%AppData%\Trados\Trados Studio\19\Plugins\Unpacked\ *</li>
</ul>
<p>Make sure that you place the *<em>.sdlplugin</em> file into the sub-folder Packages and launch Trados Studio. During startup of Trados Studio the content of the package will be automatically extracted to the Unpacked sub-folder, as illustrated below:</p>
<p>The above folder does not have to be the build output path, but it is convenient to build the project in this folder, as this will also create the *<em>.sdlplugin</em> file where it needs to be. After creating the plug-in based on the (empty) template, you could already build the project. However, it will, of course, not offer any functionality.</p>
Expand Down Expand Up @@ -145,10 +145,10 @@ <h2 id="build-and-debug-suggestions">Build and Debug Suggestions</h2>
<p>Here are a couple of simple suggestions to help buld and debug your plug-in.</p>
<ul>
<li>Change your solution and project so that it runs Trados Studio by default.</li>
<li>Change your project so that it the output is directed to the Trados Studio plug-in package directory - this will automatically deploy your plug-in. In Windows 7, the -in package directory is stored in %AppData%\Trados\Trados Studio\18\Plugins\Packages\.</li>
<li>Change your project so that it the output is directed to the Trados Studio plug-in package directory - this will automatically deploy your plug-in. In Windows 7, the -in package directory is stored in %AppData%\Trados\Trados Studio\19\Plugins\Packages\.</li>
<li>Change your project so that it deletes the previous unpacked version of your plug-in - this will ensure that Studio uses the latest version of your plug-in. This can be done using a post-build event.</li>
</ul>
<pre><code class="lang-txt">rmdir /S /Q &quot;%AppData%\Trados\Trados Studio\18\Plugins\Unpacked\ \Sdl.Sdk.FileTypeSupport.Samples.Bil&quot;
<pre><code class="lang-txt">rmdir /S /Q &quot;%AppData%\Trados\Trados Studio\19\Plugins\Unpacked\ \Sdl.Sdk.FileTypeSupport.Samples.Bil&quot;
</code></pre>
<h2 id="see-also">See Also</h2>
<p><a href="creating_a_new_project.html">Creating a New Project</a></p>
Expand Down
2 changes: 1 addition & 1 deletion apiconcepts/filetypesupport/create_a_new_bil_project.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h2 id="add-the-required-references">Add the Required References</h2>
<ul>
<li><strong>Sdl.Core.Settings.dll</strong></li>
<li><strong>Sdl.Core.PluginFramework.dll</strong>
By default you will find these files in the Trados Studio installation folder, e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>. The <strong>Copy Local</strong> property for these references should be set to True.</li>
By default you will find these files in the Trados Studio installation folder, e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>. The <strong>Copy Local</strong> property for these references should be set to True.</li>
</ul>
<p><img src="images/BilingualVerifierReferences.jpg" alt="BilingualVerifierReferences"></p>
<div class="NOTE">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h2 id="add-the-required-references">Add the Required References</h2>
<li><strong>Sdl.Core.Settings.dll</strong></li>
<li><strong>Sdl.Core.PluginFramework.dll</strong></li>
</ul>
<p>By default you find these files in the Trados Studio installation folder, usually <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>. The <strong>Copy Local</strong> property for these references should be set to True.</p>
<p>By default you find these files in the Trados Studio installation folder, usually <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>. The <strong>Copy Local</strong> property for these references should be set to True.</p>
<p><img src="images/NativeVerifierReferences.jpg" alt="NativeVerifierReferences"></p>
<div class="NOTE">
<h5>Note</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h2 id="add-the-required-references">Add the Required References</h2>
<li><strong>Sdl.Core.Settings.dll</strong></li>
<li><strong>Sdl.FileTypeSupport.Framework.Core.Settings.dll</strong></li>
</ul>
<p>Set the output path for building your project to the installation folder of Trados Studio, e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>.</p>
<p>Set the output path for building your project to the installation folder of Trados Studio, e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>.</p>
<h2 id="see-also">See Also</h2>
<p><a href="implementing_the_settings_ui.html">Implementing the Settings UI</a></p>
<p><a href="implementing_the_ui_controller_class.html">Implementing the UI Controller Class</a></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2 id="add-the-required-references">Add the Required References</h2>
<li><strong>Sdl.Core.PluginFramework.dll</strong></li>
<li><strong>Sdl.Core.Settings.dll</strong></li>
</ul>
<p>By default you find these files in the Trados Studio installation folder, usually <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>. The <strong>Copy Local</strong> property for these references should be set to True.</p>
<p>By default you find these files in the Trados Studio installation folder, usually <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>. The <strong>Copy Local</strong> property for these references should be set to True.</p>
<p>Remember to generate a key to sign the assembly. It is also recommended that you set <strong>SDLTradosStudio.exe</strong> as the external application for debugging purposes.</p>
<h2 id="add-the-required-resources">Add the Required Resources</h2>
<p>Add a resources file (<em>Resources.resx</em>) to the project's properties. We will use this resources file later for storing information text on the file type plug-in that will be exposed in the user interface of Trados Studio.</p>
Expand Down
2 changes: 1 addition & 1 deletion apiconcepts/filetypesupport/creating_a_new_project.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2 id="add-the-required-references">Add the Required References</h2>
<li><strong>Sdl.Core.Globalization.dll</strong></li>
<li><strong>Sdl.FileTypeSupport.Framework.Core.Utilities</strong></li>
</ul>
<p>By default these files can be found in the installation folder of Trados Studio, i.e. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>. The 'Copy Local' property for these references should be set to True.</p>
<p>By default these files can be found in the installation folder of Trados Studio, i.e. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>. The 'Copy Local' property for these references should be set to True.</p>
<p><img src="images/NativeFilterRef.jpg" alt="NativeFilterRef"></p>
<div class="NOTE">
<h5>Note</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h2 id="creating-a-varproductname-command-line-argument-processor">Creating a Tr
</li>
</ul>
<p>If you don't implement <a href="../../api/integration/Sdl.Desktop.IntegrationApi.Extensions.CommandLine.IExternalCommandLineProcessor.html">IExternalCommandLineProcessor</a> or <a href="../../api/integration/Sdl.Desktop.IntegrationApi.Extensions.CommandLine.IExternalWindowAwareCommandLineProcessor.html">IExternalWindowAwareCommandLineProcessor</a>, an exception will be thrown, but if you omit the <a href="../../api/integration/Sdl.Desktop.IntegrationApi.Extensions.CommandLine.ExternalCommandLineProcessorAttribute.html">ExternalCommandLineProcessorAttribute</a>, your plugin will simply be ignored when Trados Studio starts.</p>
<p>After successfully creating your command line processor you can check the Help generated for it by and running the following command in cmd.exe : C:\Program Files (x86)\Trados\Trados Studio\Studio18\SdlTradosStudio.exe ? . Your command will appear, among other commands available, in the following screen :
<p>After successfully creating your command line processor you can check the Help generated for it by and running the following command in cmd.exe : C:\Program Files (x86)\Trados\Trados Studio\Studio19\SdlTradosStudio.exe ? . Your command will appear, among other commands available, in the following screen :
<img style="display:block; " src="images/cmdHelpWindow.jpg"></p>
<p>[Creating a Trados Studio Command line processor Sample]
(trados_studio_command_processor.md)</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h2 id="how-to-create-the-visual-studio-project">How to create the Visual Studio
<div class="IMPORTANT">
<h5>Important</h5>
<p>The <em>The Sdl.Core.Globalization</em> assembly is not automatically added to the project with the Trados Studio (2021) template. This assembly will be required for this project, as we will be making reference to some of the <a href="../../api/filetypesupport/Sdl.FileTypeSupport.Framework.BilingualApi.ISegmentPair.html">ISegmentPair</a> enumerators.</p>
<p>To add this assembly, from the Solution Explorer, right-click on the <strong>References</strong> node and click <strong>Add Reference</strong> from the context menu. Then, navigate to the <strong>C:\Program Files (x86)\Trados\Trados Studio\Studio18</strong> and select the <strong>Sdl.Core.Globalization.dll file</strong>.</p>
<p>To add this assembly, from the Solution Explorer, right-click on the <strong>References</strong> node and click <strong>Add Reference</strong> from the context menu. Then, navigate to the <strong>C:\Program Files (x86)\Trados\Trados Studio\Studio19</strong> and select the <strong>Sdl.Core.Globalization.dll file</strong>.</p>
</div>
<h2 id="how-to-sign-the-solution">How to sign the solution</h2>
<p>To sign your development solution from the project properties area.</p>
Expand Down
4 changes: 2 additions & 2 deletions apiconcepts/integration/studio_automation.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ <h1 id="introduction">Introduction</h1>
</ul>
<div class="NOTE">
<h5>Note</h5>
<p>As build output path for your implementations please choose the <em>%AppData%\Trados\Trados Studio\18\Plugins\Packages\</em>.</p>
<p>Also check that your library references are pointing to the Trados Studio folder. e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>.</p>
<p>As build output path for your implementations please choose the <em>%AppData%\Trados\Trados Studio\19\Plugins\Packages\</em>.</p>
<p>Also check that your library references are pointing to the Trados Studio folder. e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>.</p>
<p>For more information on how to build and deploy a Studio plug-in, see (Building a plug-in and Plug-in deployment)</p>
<p>Sign and use Strong-Named Assemblies to enable the loading of your plug-ins inside the Trados Studio.</p>
<p><a href="https://docs.microsoft.com/en-us/dotnet/standard/assembly/sign-strong-name?redirectedfrom=MSDN">How to: Sign an Assembly with a Strong Name</a></p>
Expand Down
4 changes: 2 additions & 2 deletions apiconcepts/integration/user_interface_integration.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ <h1 id="introduction">Introduction</h1>
</ul>
<div class="NOTE">
<h5>Note</h5>
<p>As build output path for your implementations please choose the <em>%AppData%\Trados\Trados Studio\18\Plugins\Packages\</em>.</p>
<p>Also check that your library references are pointing to the Trados Studio folder. e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em>.</p>
<p>As build output path for your implementations please choose the <em>%AppData%\Trados\Trados Studio\19\Plugins\Packages\</em>.</p>
<p>Also check that your library references are pointing to the Trados Studio folder. e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em>.</p>
<p>For more information on building an deploying a Trados Studio plug-in, see (Building a plug-in and Plug-in deployment).</p>
<p>Sign and use Strong-Named Assemblies to enable the loading of your plug-ins inside the Trados Studio.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion apiconcepts/projectautomation/about_project_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h2 id="reference-files">Reference Files</h2>
<p>Reference files are files that need to be part of the project, for instance for preview reasons, but that can be changed as part of the project. Reference files are language files, which means they are associated with a particular project language.</p>
<p>Reference files are represented by the <code>IReferenceFile</code> interface in the object model.</p>
<img style="display:block; " src="images/NewProject03.jpg">
<p>The screenshot above illustrates how project files are selected in Trados Studio 2024 SR1.</p>
<p>The screenshot above illustrates how project files are selected in Trados Studio 2026 Release.</p>
<h2 id="see-also">See also</h2>
<p><a href="adding_files_and_folders.html">Adding Files and Folders</a></p>
<p><a href="creating_a_merged_file.html">Creating a Merged File</a></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h2 id="namespaces-to-use">Namespaces to Use</h2>
<h2 id="further-requirements">Further Requirements</h2>
<p>In addition to the above, you should observer the following:</p>
<ul>
<li>As build output location choose the installation folder of Trados Studio , e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio18</em></li>
<li>As build output location choose the installation folder of Trados Studio , e.g. <em>C:\Program Files (x86)\Trados\Trados Studio\Studio19</em></li>
<li>Configure your projects as x84 applications, as otherwise they will not work when running on 64 bit platforms. Therefore, set the platform target of your projects to x84.</li>
</ul>
<h2 id="references-from-the-translation-memory-api">References from the Translation Memory API</h2>
Expand Down
Loading