Skip to content

Commit deef0c5

Browse files
authored
Merge pull request #19 from RWS/main_fix_variableNames
Prevent variable names from being converted to links.
2 parents 8e96f57 + 087117b commit deef0c5

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@ In order for you to make a contribution directly please follow the next steps:
3333
- if you wish to test your changes locally you can follow the [DOCFX Installation guideline](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) and [build the entire solution locally](https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html)
3434
- 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 '<var:VariableName>' construct to tell our documentation engine to fill in the info for you. Here are the constructs available at this point:
3535

36-
<var:ProductName> - The product name, for example Trados Cloud
36+
Var:ProductName - The product name, for example Trados Cloud
3737

index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Access the <Var:ProductName> APIs
2-
<Var:ProductName> is the platform on which RWS host a number of products. You're in the right place if you're looking for API documentation for any of the following:
1+
# Access the Var:ProductName APIs
2+
Var:ProductName is the platform on which RWS host a number of products. You're in the right place if you're looking for API documentation for any of the following:
33
- Trados Enterprise
44
- Trados Accelerate
55
- Trados Team
66
- Trados Ignite
77
- Trados Studio (cloud capabilities)
88
- Trados Go
99

10-
## Integrating with <Var:ProductName> products
10+
## Integrating with Var:ProductName products
1111
To create an integration with any of the products listed above, you'll need to use the Public API. You can find the documentation for the API [here](https://languagecloud.sdl.com/lc/api-docs). Note that the API is updated regularly so make sure that you check out the [What's new](https://languagecloud.sdl.com/lc/api-docs/whats-new) section to find out information on recently added features. To enable RWS to extend and improve the API, and to support the latest features in the products, sometimes it's necessary to remove or change functionality. For that, you'll need to check the [What's deprecated](https://languagecloud.sdl.com/lc/api-docs/whats-deprecated) page where RWS will post advance notice of any API endpoints that will be removed or change in the future. Don't worry though because RWS will try and give six months notice of any breaking changes.
1212

13-
## Extending <Var:ProductName> products
14-
<Var:ProductName> products can be extended in a number of ways. For example, you may want to create an add-on to support a machine translation engine or you may want to create a custom workflow task. RWS provides an extensibility framework for the <Var:ProductName> suite of products. To get more information on what's required and how you can do this, visit the [<Var:ProductName> extensibility documentation](https://languagecloud.sdl.com/lc/extensibility-docs) pages.
13+
## Extending Var:ProductName products
14+
Var:ProductName products can be extended in a number of ways. For example, you may want to create an add-on to support a machine translation engine or you may want to create a custom workflow task. RWS provides an extensibility framework for the Var:ProductName suite of products. To get more information on what's required and how you can do this, visit the [Var:ProductName extensibility documentation](https://languagecloud.sdl.com/lc/extensibility-docs) pages.
1515

1616
## Interacting with files
17-
Translatable content in <Var:ProductName> is held in a format called **Bilingual Content Model**, or **BCM** for short. You can find **BCM** reference documentation and samples on this site. Click [here](articles/bcm/BCM.NET_client_API.md) to find out more.
17+
Translatable content in Var:ProductName is held in a format called **Bilingual Content Model**, or **BCM** for short. You can find **BCM** reference documentation and samples on this site. Click [here](articles/bcm/BCM.NET_client_API.md) to find out more.
1818

1919
## Reporting API issues ##
2020
If you want to report an issue with the API, you can find information on how to do this here - [How to report an issue](https://languagecloud.sdl.com/lc/api-docs/how-to-report-an-issue)

0 commit comments

Comments
 (0)