No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Resources
Sdl.Community.Toolkit.Core
Sdl.Community.Toolkit.Integration
Sdl.Community.Toolkit.LanguagePlatform
Sdl.Community.Toolkit.ProjectAutomation
Sdl.CommunityToolkit.FileType
.gitattributes
.gitignore
LICENSE
README.md
ReleaseNotes.md
SDL Studio Community Toolkit.sln
Sdl.Community.Toolkit.Core.nuspec
Sdl.Community.Toolkit.FileType.nuspec
Sdl.Community.Toolkit.Integration.nuspec
Sdl.Community.Toolkit.LanguagePlatform.nuspec
Sdl.Community.Toolkit.ProjectAutomation.nuspec
Sdl.Community.Toolkit.snk
SolutionInfo.cs
build.cmd
build.fsx
contributing.md

README.md

SDL-Studio-Community-Toolkit

The SDL Studio Community Toolkit is a collection of helper functions. It simplifies and demonstrates common developer tasks building SDL Studio plugins.

Supported platforms

  • .NET 4.5 (Desktop / Server)
  • Windows 7 / 8 / 8.1 /10 Store Apps
  • SDL Studio 2017 or later

Getting started

This libraries are build on top of SDL Studio APIs and thus using them also requires having SDL Studio installed.

  1. Install Visual Studio 2013 or 2015. The community edition is available for free here.

  2. Open the solution for an existing SDL Studio plugin or create a new one.

  3. In Solution Explorer panel, right click on your project name and select Manage NuGet packages. Search for Sdl.Community.Toolkit, and choose your desired NuGet Packages from the list.

Manage Nuget packages

  1. In your C# class, add the namespaces to the toolkit, for example:
using Sdl.Community.Toolkit.Integration
  1. Use the extensions for existing API classes.

Nuget Packages

NuGet is a standard package manager for .NET applications that is built into Visual Studio. From your open solution choose the Tools menu, NuGet Package Manager, Manage NuGet packages for solution... to open the UI. Enter one of the package names below to search for it online.

Community Toolkit Nuget packages

NuGet Package Name description
Sdl.Community.Toolkit.Core NuGet package includes helper methods for Studio versions.
Sdl.Community.Toolkit.FileType NuGet package that includes helper metods for FileType Support Framework classes, like ISegment, ISegmentPairs or ITranslationOrigin.
Sdl.Community.Toolkit.ProjectAutomation NuGet package that includes helper methods for ProjectAutomation API classes, like ProjectTemplateInfo.
Sdl.Community.Toolkit.LanguagePlatform NuGet package that includes helper methods for LanguagePlatform working with the Translation Memory API; e.g. recover additional information for ISegmentPair (FileTypeSupport.Framework), that includes the LanguagePlatform representation of the segment and word counts
Sdl.Community.Toolkit.Integration NuGet package that includes helper methods for Integration API classes, like DisplayFilterRowInfo or Document.

Features

  • Helper functions for working with FileTypeSupport Framework
  • Helper functions for working with ProjectAutomation API
  • Helper functions for working with LanguagePlatform
  • Helper functions for working with Integration API
  • Helper functions for handling SDL Studio versioning

Feedback and Requests

Please use GitHub issues for questions or comments.

Contributing

Do you want to contribute? Here are our contribution guidelines.

Principles

  • Principle #1: The toolkit will be kept simple.
  • Principle #2: As soon as a comparable feature is available in the SDL Studio, it will be marked as deprecated.
  • Principle #3: All features will be supported for the latest SDL Studio release cycles or until another principle supersedes it.