Skip to content

Commit

Permalink
Expand documentation on valid text files (#176)
Browse files Browse the repository at this point in the history
* Expand documentation on valid text files

Note: This was part of earlier work done when addressing the issue of strict parsing before it was decided that Serval should not validate files. It would still be beneficial to incorporate.

* Fix typo

* Remove extra tab

* Fix merge error

* Build to update Client.g.cs
  • Loading branch information
Enkidu93 authored Oct 10, 2023
1 parent 0f7d71f commit 0f6a78e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
14 changes: 10 additions & 4 deletions src/Serval.Client/Client.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,11 @@ public partial interface IDataFilesClient
/// <param name="file">The file to upload. Max size: 100MB</param>
/// <param name="format">File format options:
/// <br/>* **Text**: One translation unit (a.k.a., verse) per line
/// <br/> * If there is a tab, the content before the tab is the unique identifier for the line
/// <br/> * Otherwise, no tabs should be used in the file.
/// <br/> * If a line contains a tab, characters before the tab are used as a unique identifier for the line, characters after the tab are understood as the content of the verse, and if there is another tab following the verse content, characters after this second tab are assumed to be column codes like "ss" etc. for sectioning and other formatting. See this example of a tab-delimited text file:
/// <br/> &gt; verse_001_005 (tab) Ὑπομνῆσαι δὲ ὑμᾶς βούλομαι , εἰδότας ὑμᾶς ἅπαξ τοῦτο
/// <br/> &gt; verse_001_006 (tab) Ἀγγέλους τε τοὺς μὴ τηρήσαντας τὴν ἑαυτῶν ἀρχήν , ἀλλὰ (tab) ss
/// <br/> &gt; verse_001_007 (tab) Ὡς Σόδομα καὶ Γόμορρα , καὶ αἱ περὶ αὐτὰς πόλεις (tab) ss
/// <br/> * Otherwise, *no tabs* should be used in the file and a unique identifier will generated for each translation unit based on the line number.
/// <br/>* **Paratext**: A complete, zipped Paratext project backup: that is, a .zip archive of files including the USFM files and "Settings.xml" file. To generate a zipped backup for a project in Paratext, navigate to "Paratext/Advanced/Backup project to file..." and follow the dialogue.</param>
/// <param name="name">A name to help identify and distinguish the file.
/// <br/>Recommendation: Create a multi-part name to distinguish between projects, uses, languages, etc.
Expand Down Expand Up @@ -231,8 +234,11 @@ public string BaseUrl
/// <param name="file">The file to upload. Max size: 100MB</param>
/// <param name="format">File format options:
/// <br/>* **Text**: One translation unit (a.k.a., verse) per line
/// <br/> * If there is a tab, the content before the tab is the unique identifier for the line
/// <br/> * Otherwise, no tabs should be used in the file.
/// <br/> * If a line contains a tab, characters before the tab are used as a unique identifier for the line, characters after the tab are understood as the content of the verse, and if there is another tab following the verse content, characters after this second tab are assumed to be column codes like "ss" etc. for sectioning and other formatting. See this example of a tab-delimited text file:
/// <br/> &gt; verse_001_005 (tab) Ὑπομνῆσαι δὲ ὑμᾶς βούλομαι , εἰδότας ὑμᾶς ἅπαξ τοῦτο
/// <br/> &gt; verse_001_006 (tab) Ἀγγέλους τε τοὺς μὴ τηρήσαντας τὴν ἑαυτῶν ἀρχήν , ἀλλὰ (tab) ss
/// <br/> &gt; verse_001_007 (tab) Ὡς Σόδομα καὶ Γόμορρα , καὶ αἱ περὶ αὐτὰς πόλεις (tab) ss
/// <br/> * Otherwise, *no tabs* should be used in the file and a unique identifier will generated for each translation unit based on the line number.
/// <br/>* **Paratext**: A complete, zipped Paratext project backup: that is, a .zip archive of files including the USFM files and "Settings.xml" file. To generate a zipped backup for a project in Paratext, navigate to "Paratext/Advanced/Backup project to file..." and follow the dialogue.</param>
/// <param name="name">A name to help identify and distinguish the file.
/// <br/>Recommendation: Create a multi-part name to distinguish between projects, uses, languages, etc.
Expand Down
7 changes: 5 additions & 2 deletions src/Serval.DataFiles/Controllers/DataFilesController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,11 @@ public async Task<ActionResult<DataFileDto>> GetAsync([NotNull] string id, Cance
/// <param name="format">
/// File format options:
/// * **Text**: One translation unit (a.k.a., verse) per line
/// * If there is a tab, the content before the tab is the unique identifier for the line
/// * Otherwise, no tabs should be used in the file.
/// * If a line contains a tab, characters before the tab are used as a unique identifier for the line, characters after the tab are understood as the content of the verse, and if there is another tab following the verse content, characters after this second tab are assumed to be column codes like "ss" etc. for sectioning and other formatting. See this example of a tab-delimited text file:
/// > verse_001_005 (tab) Ὑπομνῆσαι δὲ ὑμᾶς βούλομαι , εἰδότας ὑμᾶς ἅπαξ τοῦτο
/// > verse_001_006 (tab) Ἀγγέλους τε τοὺς μὴ τηρήσαντας τὴν ἑαυτῶν ἀρχήν , ἀλλὰ (tab) ss
/// > verse_001_007 (tab) Ὡς Σόδομα καὶ Γόμορρα , καὶ αἱ περὶ αὐτὰς πόλεις (tab) ss
/// * Otherwise, *no tabs* should be used in the file and a unique identifier will generated for each translation unit based on the line number.
/// * **Paratext**: A complete, zipped Paratext project backup: that is, a .zip archive of files including the USFM files and "Settings.xml" file. To generate a zipped backup for a project in Paratext, navigate to "Paratext/Advanced/Backup project to file..." and follow the dialogue.
/// </param>
/// <param name="idGenerator"></param>
Expand Down

0 comments on commit 0f6a78e

Please sign in to comment.