Update 'translate/file-formats/01.md'

Issue 157. Removed section on Markdown and made clearer with "writing with USFM markers."
This commit is contained in:
Susan Quigley 2019-08-21 12:31:46 +00:00
parent 4bb22aa5c5
commit e358472a17
1 changed files with 3 additions and 27 deletions

View File

@ -22,35 +22,11 @@ To read more about USFM notation, please read http://paratext.org/about/usfm .
#### How To Do a Bible Translation in USFM
Most people do not know how to write in USFM. This is one of the reasons why translationStudio was created. When you do a translation in translationStudio, what you see looks very similar to a normal word processor document without any markup language. However, translationStudio is formatting the Bible translation in USFM underneath what you see. This way, when you upload your translation from translationStudio, what is being uploaded is already formatted in USFM and can be immediately published in a variety of formats.
Most people do not know how to write using USFM markers. This is one of the reasons why translationStudio was created. When you do a translation in translationStudio, what you see looks very similar to a normal word processor document without showing the USFM markers. This way, when you upload your translation from translationStudio, what is being uploaded is already formatted in USFM.
#### Converting a Translation to USFM
Though it is strongly encouraged to only do a translation using USFM notation, sometimes a translation is done without using USFM markup. This type of translation still can be used, but first the USFM markers must be added. One way to do this is to copy and paste it into translationStudio, then place the verse markers in the correct place. When this is done, the translation will be able to be exported as USFM. This is a very arduous task, so we strongly recommend doing your Bible translation work from the beginning in translationStudio or some other program that uses USFM.
### Markdown for Other Content
Markdown is a very common markup language that is used in many places on the Internet. Using Markdown makes it very easy for the same text to be used in a variety of formats (such as webpage, mobile app, PDF, etc).
Markdown supports **bold** and *italic*, written like this:
Markdown supports **bold** and *italic*.
Markdown also supports headings like this:
# Heading 1
## Heading 2
### Heading 3
Markdown also supports links. Links display like this https://unfoldingword.org and are written like this:
https://unfoldingword.org
Customized wording for links are also supported, like this:
[uW Website](https://unfoldingword.org)
Note that HTML is also valid Markdown. For a complete listing of Markdown syntax please visit https://www.markdownguide.org/cheat-sheet
Though it is strongly encouraged to only do a translation using USFM markers, sometimes a translation is done without using USFM. This type of translation still can be used, but first the USFM markers must be added. One way to do this is to copy and paste it into translationStudio, then place the verse markers in the correct place. When this is done, the translation will be able to be exported as USFM. This is a very arduous task, so we strongly recommend doing your Bible translation work from the beginning in translationStudio or some other program that uses USFM markers.
### Conclusion
@ -58,5 +34,5 @@ The easiest way to get content marked up with USFM or Markdown is by using an ed
*Note: Making text bold, italic, or underlined in a word processor does not make it bold, italic, or underlined in a markup language. This type of formatting must be done by writing the designated symbols.*
When contemplating which software to use, please keep in mind that translation is not just about words; there are a lot of technical aspects that need to be taken into consideration. Whatever software is used, just remember that Bible translations need to be put into USFM, and everything else needs to be put into Markdown.
When contemplating which software to use, please keep in mind that translation is not just about words; there are a lot of technical aspects that need to be taken into consideration. Whatever software is used, just remember that Bible translations need to be written using USFM markers.