DCS-Mirror
/
Bussard_fr_tn
mirror of https://git.door43.org/Bussard/fr_tn
2
0
Fork 0
Files Issues Releases Wiki Activity See in Reader

Readme clarifications

This commit is contained in:
Jesse Griffin 2018-06-07 12:25:26 -04:00
parent ca5828eb3d
commit c56a227dcd
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -11,17 +11,17 @@ unfoldingWord tN are open-licensed exegetical notes that provide historical, cul
To edit the tN files there are three options:
* Use LibreOffice (Recommended)
* Use the online web editor in DCS
* Use a text editor on your computer
* Use the online web editor in DCS
Each of these options and there caveats are described below.
The first two options require you to clone the repository to your computer first. You may do this on the command line or using a program such as SmartGit. After making changes to the files you will need to commit and push your changes to the server and then create a Pull Request to merge them to the `master` branch.
### Editing in LibreOffice
This is the recommended way to edit the TSV files. You may [download LibreOffice](https://www.libreoffice.org/download/download/) for free.
First, clone this repository to your local system, either using the command line or a git client like SmartGit.
After you have the file on your computer, you may open the respective TSV file with LibreOffice. Follow these notes on the Text Import Screen:
* Set "Separated by" to "Tab"
@ -36,18 +36,18 @@ When you are done editing, click Save and then select "Use Text CSV Format" on t
**Note:** Other spreadsheet editors **should not** be used because they will add or remove quotation marks which will affect the notes negatively.
### Editing in DCS
If you only need to change a word or two, this may be the quickest way to make your change. See the [protected branch workflow](https://help.door43.org/en/knowledgebase/15-door43-content-service/docs/46-protected-branch-workflow) document for step by step instructions.
**Note:** You must be careful not to delete any tab characters when editing with this method.
### Editing in a Text Editor
You may also use a regular text editor to make changes to the files.
**Note:** You must be careful not to delete or add any tab characters when editing with this method.
### Editing in DCS
If you only need to change a word or two, this may be the quickest way to make your change. See the [protected branch workflow](https://help.door43.org/en/knowledgebase/15-door43-content-service/docs/46-protected-branch-workflow) document for step by step instructions.
**Note:** You must be careful not to delete any tab characters when editing with this method.
## Structure
The tN are structured as TSV files to simplify importing and exporting into various formats for translation and presentation. This enables the tNs to be keyed to the original Greek and Hebrew text instead of only a Gateway Language translation.