DCS-Mirror
/
unfoldingWord_en_tn
mirror of https://git.door43.org/unfoldingWord/en_tn
2
0
Fork 0
Files Issues Releases Wiki Activity See in Reader

Edit "Composing tNotes" section (#1505) 

Update 'README.md'

Reviewed-on: https://git.door43.org/unfoldingWord/en_tn/pulls/1505
This commit is contained in:
Joel D. Ruark 2020-10-29 02:59:42 +00:00
parent 149f495052
commit 4ae8571afa
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -104,11 +104,13 @@ The following lists each column with a brief description and example.
## Composing translationNotes
Below are a few formatting guidelines that govern the composition of transationNotes.
* All tNotes should reference ONLY a single translationAcademy article. If a second article needs to be referenced, an additional tNote should be added.
* All tNotes should reference one of the "Just-in-Time" articles from translationAcademy, i.e., those with file names beginning with "figs-" or "grammar-" "translate-" or "writing-."
* The ULT term/concept being discussed in each Note should be in **bold type**, NOT in "quotation marks."
* Only use quotation marks to indicate suggested translations. Do not precede the suggestion with the word "that" (which turns them into indirect quotes) i.e., You could say that “they were planning to assassinate him.” Corrected to: You could say, “they were planning to assassinate him.”
* It is not enough to enclose "for example" in commas mid sentence and follow it with an example, i.e., You can say this with an active form, for example, “Mordecai found out what they were planning.” Corrected to: You can say this with an active form such as “Mordecai found out what they were planning.” Another example might include: You can say this with an active form, and you can say who did the action. For example, you can say, “Then the king's servants investigated Mordecai's report and found out that it was true.”
* When beginning a tNotes with the word "Here," the term should be followed by a comma. For instance: "Here, the **ULT term** means __________."
* Do NOT include a period at the end of the "Alternate translation:" fragment at the end of a tNotes. The "Alternate translation" should be formatted as a floating sentence fragment immediately followed by the tA hyperlink (if applicable), i.e., Alternation translation: "in the presence of Yahweh" (See: Metaphor)
* Do NOT include a period at the end of the "Alternate translation:" fragment at the end of a tNotes. The "Alternate translation" should be formatted as a floating sentence fragment immediately followed by the translationAcademy hyperlink (if applicable), i.e., Alternation translation: "in the presence of Yahweh" (See: Metaphor)
* When composing tNotes using tC Create, all hyperlinks should be typed in "Markdown" mode instead of "Preview" mode. Hyperlinks entered in Preview mode will not be saved in their proper format.
* Scripture references within the same book should be referenced using both chapter and verse, separate by a colon, i.e. 3:16. To use this same example, the proper hyperlink format places the hyperlink text in brackets [3:16] immediately followed by the link itself in parentheses (../03/16.md). There should not be a space between the brackets and the parentheses.
* The file name in the SupportReference field MUST be an exact match for the hyperlink at the close of the tNote. If they do not match, the link will not work properly.