From f85ee94571d729dd2ca640bea24f9d78a8246c40 Mon Sep 17 00:00:00 2001 From: daobrien Date: Thu, 29 Jul 2021 12:33:53 +1000 Subject: [PATCH] Fixes #245 --- en-US/Translation.xml | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/en-US/Translation.xml b/en-US/Translation.xml index 435afd5..7800861 100644 --- a/en-US/Translation.xml +++ b/en-US/Translation.xml @@ -14,7 +14,7 @@ This section describes how to construct your content for clarity and readability. A full discussion of this topic is beyond the scope of this guide. - +
Using and Formatting Lists @@ -71,7 +71,7 @@ You can nest lists, but try to keep the number of levels to two or fewer. To nest procedures in DocBook, use <substep> elements. - +
Formatting Lists for Readability @@ -80,7 +80,7 @@ The same consideration applies to lists. If you use DocBook to build itemized, ordered, or variable (definition) lists, you can use the or attributes to specify the spacing between list items. DocBook uses the spacing attribute by default. - + Use a list with normal spacing if any list item contains the following components: @@ -112,7 +112,7 @@ - + The following discussion provides some initial insight into using lists correctly. See the IBM Style Guide for a full discussion. @@ -182,7 +182,7 @@
- +
Noun Stacking @@ -252,7 +252,7 @@ The RPM is useful. The RPM package is useful. OR The RPM Package Manager is useful. - + @@ -264,18 +264,16 @@
- DocBook Elements + Using Markup Correctly + + If you use a markup language to write your content, make the most of the available tagging options. + Many terms are not translatable, and should not be used as structural parts of a sentence. + - Use the correct DocBook elements to help translators to understand the meaning of, and to identify, translatable and non-translatable terms. + Correctly marking up terms can help translators to understand the meaning of, and to identify, translatable and non-translatable terms. - - - Tagged Terms in Sentences - - Many tagged terms are not translatable, and so they should not be used as structural parts of a sentence. Otherwise, translators must complete the blanks or tag terms themselves. - - + @@ -316,6 +314,12 @@
+ + + This guide does not try to cover the many ways that you can use markup languages to write content. + Many online resources exist for these languages. + +
@@ -339,7 +343,7 @@ . Entities are called by reference, and take the form &name; (both the ampersand and the semicolon are required). - + Entities can be helpful in some cases, but they are more of a hindrance when used for terms that need translation. Translators must compare the string with the built document to determine what the entity stands for. These entities might even be overlooked and not be translated at all.