Merge pull request #60 from bible-technology/Juxta

Juxta and pdf generator files added

docs/scribe/Getting-Started/p0-1-what-is-scribe-SE.md

@@ -4,9 +4,10 @@ sidebar_label: What is Scribe SE?
 title: What is Scribe SE?
 slug: '/'
 ---
-:::tip Feature Introduced in version 0.6.1
+:::tip Feature Introduced in version 0.7.0
 
-[Scope Management](../Manage%20Project/Projects/p3-7-scope%20management.md)
+- [PDF Generator](../Modes/Common%20Functionality/p5-3-pdf%20generator.md)
+- [Juxtalinear (Juxta)](../Modes/Juxtalinear/p10-2-what%20is%20juxtalinear.md)
 
 :::
 

docs/scribe/Modes/Common Functionality/p5-3-pdf generator.md

@@ -0,0 +1,51 @@
+---
+id: p5-3-pdfgenerator
+sidebar_label: PDF Generator
+title: PDF Generator
+---
+
+# PDF generator
+
+The PDF generator is available in BT, OBS and Juxta modes.
+
+## Current limitations
+- Close the export pane will reset its parameters. If you want to try different settings, be sure to keep the pane open between prints
+- The **Reset** button <img src="/0.7.0/Reset.png"  width="50px" alt="reset.png"/> has a specific effect: it will only reset modified input fields **below a Print type** field (they appear once a Print type is selected)
+- For **Translation** content (BT, Juxta), the **Book selection** has a toggle on/off behavior <img src="/0.7.0/Bookselection.png"  width="500px" alt="bookselection"/>
+- Right to Left (RTL) languages are not supported
+
+## Steps to use the PDF generator
+### Default mode
+
+Default mode prints the current opened Scribe project, with one layout.
+
+- Click the **Print** button <img src="/0.7.0/Print.png"  width="50px" alt="print"/> on the top right corner of the screen
+
+- An export pane will open
+- Edit general settings as needed (**Paper size**, **Font**, **Font size**)
+- The **Content** added below those general settings depend on the project from which you launched the PDF generator:
+  - A **Translation** block for BT and Juxta projects
+  - An **OBS** block for OBS projects
+- In both cases, select a print range:
+  - Translation: which books to print (**All Books**, **Old Testament**, **New Testament**, **Custom**)
+  - OBS: which stories to print (the number of the **obs start**, and the **obs end**)
+
+- **Print type** available options vary depending on the content block type (Translation, OBS), select a **Print type** option
+- Each Print type has specific settings, they appear below it once a Print type is selected. Most of these settings are optional
+- **Choose an export folder** with the corresponding button
+- You can name your file in the **your file name here** field, or it will be named randomly
+- Click the **Print** button
+- If a mandatory field is empty or is wrongly filled, an error appear on the right side of the export pane to help locate the error
+- Without errors, generation steps appear on the right side of the export pane, wait for the **Successful pdf generation** final message
+
+### Advanced mode
+**Advance mode** may be used to generate a single PDF containing many different projects with many different layouts, as well as introductions and imported PDFs. It is also more technical to configure.
+- With **Advanced mode** active, three new options are available:
+  - The automatically added project (the one currently opened in Scribe) can be modified with the **Select** button <img src="/0.7.0/Select.png"  width="50px" alt="select"/>, on the right of the project name
+  - A new content block can be added with the **Add** button <img src="/0.7.0/Addblock.png"  width="70px" alt="addblock"/>
+    - Content will be printed by order of appearance in the export pane
+    - Once two or more content blocks are listed, they can be deleted with the **Trash** button <img src="/0.7.0/Trash.png"  width="40px" alt="trash"/>
+  - **Loop mode** can be used; when active, one new option is available:
+    - Inside a content block, a new project can be added with the **Add** button <img src="/0.7.0/Addproject.png"  width="50px" alt="addproject"/>
+      - Content will be printed by order of appearance in the content block, **for each book or story selected** (so in loop)
+      - Once two or more projects are listed inside a content block, they can be deleted with the **Trash** button  <img src="/0.7.0/Trash.png"  width="40px" alt="trash"/>

docs/scribe/Modes/Common Functionality/p5-3-font size.md → docs/scribe/Modes/Common Functionality/p5-4-font size.md

@@ -1,5 +1,5 @@
 ---
-id: p5-3-font size
+id: p5-4-font size
 sidebar_label: Font Size
 title: Font Size
 ---

docs/scribe/Modes/Common Functionality/p5-4-Sync.md → docs/scribe/Modes/Common Functionality/p5-5-Sync.md

@@ -1,5 +1,5 @@
 ---
-id: p5-4-Sync
+id: p5-5-Sync
 sidebar_label: Sync
 title: Sync
 ---

docs/scribe/Modes/Juxtalinear/p10-1-juxtalinear overview.md

@@ -0,0 +1,9 @@
+---
+id: p10-1-juxtalinearoverview
+sidebar_label: Juxtalinear Overview
+title: Juxtalinear Overview
+---
+
+This mode allows the translator to do a hyper-literal bilingual translation. The final translation is in two columns, with the Source Text on the left (most commonly, Greek or Hebrew), and the Target Text on the right (a Gateway Language). As for the Text Bible Translation mode, translators can also access and compare different versions of the Bible in the resource pane.
+
+For more information, see the [What is Juxtalinear?](../Juxtalinear/p10-2-what%20is%20juxtalinear.md) page.

docs/scribe/Modes/Juxtalinear/p10-2-what is juxtalinear.md

@@ -0,0 +1,19 @@
+---
+id: p10-2-whatisjuxtalinear
+sidebar_label: What is Juxtalinear
+title: What is Juxtalinear?
+---
+
+A juxtalinear is a bilingual view of a text. It has two columns:
+- on the left, a Source Text is rearranged and broken up into small grammatically-meaningful chunks;
+- on the right, a hyper-literal translation of each chunk.
+
+<img src="/0.7.0/WhatisJuxtalinear-en.png"  width="1000px" alt="What is Juxtalinear"/>
+
+Juxtalinears provide a bridge between Source and Target Languages. The hyper-literal translation is very close to the Source Text meaning, in a way that limits the risks of misinterpretation. Additionally, the chunks size (a few words that belong together grammatically) provides context. In the end, juxtalinears are comprehensible and leave open most contended options in interpretation.
+
+Juxtalinears are starting to be used within the CCBT context. The common use case would be:
+- a linguist familiar with Greek creates a *Greek to Gateway Language* juxtalinear;
+- CCBT translators use the juxtalinear along other Gateway Language resources, to help them get a clearer idea of the original text meaning.
+
+Juxtalinears can be done from any language to any other, but it is commonly done from an ancient language (Greek or Hebrew) to a Gateway Language.

docs/scribe/Modes/Juxtalinear/p10-3-drafting.md

@@ -0,0 +1,44 @@
+---
+id: p10-3-drafting
+sidebar_label: Drafting
+title: Drafting
+---
+
+## Steps to draft a Juxtalinear
+- [Create a new project](https://docs.scribe.bible/scribe/Manage%20Project/Create%20a%20Project/p2-1-new%20project) using the **Juxta** Project Type
+  - In this mode, it is mandatory to use **Import Books** <img src="/assets/import01.PNG"  width="70px" alt="import"/>
+  - The imported file will be used as the juxtalinear left column (Source Text)
+  - The user have two options here:
+    - Find a USFM format file on [Door43](https://git.door43.org/catalog), download it, and select it from the dialog
+    - Use a local USFM or JSON format file. For JSON format files only, the user must rename the file with the abbreviated book name (e.g., MRK.json or mrk.json)
+  - Both individual and multiple books can be imported
+  - Note that it will be possible to create a juxtalinear **only** for the books available in the uploaded Source Text file
+- Select the created Juxta project from the Projects page
+- If needed, setup project [layout](https://docs.scribe.bible/scribe/Modes/Common%20Functionality/p5-1-layout) and [reference resources](https://docs.scribe.bible/scribe/Modes/Common%20Functionality/p5-2-resources)
+## How to work on a Juxtalinear?
+- When starting a juxtalinear, the user will see a Source Text sentence (a few verses) displayed on a single line
+<img src="/0.7.0/Drafting.PNG"  width="1000px" alt="Drafting.png"/>
+
+
+- From here, working on a juxtalinear consists of:
+  - Splitting the Source Text sentence into small grammatically-meaningful chunks (containing words that belong together grammatically)
+    - Double-click on a word to split the sentence on that specific word
+    - Double-click on a chunk first word to merge it back with the previous chunk
+  - Rearranging the Source Text to approach the natural Target Language word order
+    - Hold click on a word
+    - Drag the word within the line, or between lines
+    - Release the click
+  - Adding a hyper-literal translation for each chunk
+    - Add a translation with a double-click on a text field or with a click on **Edit** <img src="/0.7.0/JuxtaEditbutton.png"  width="40px" alt="Juxta Edit button"/>
+    - Type a translation
+    - Exit editing with a click outside the text field or with a click on **Check** <img src="/0.7.0/JuxtaCheckbutton.png"  width="40px" alt="Juxta Check button"/>
+  - Note that these three steps can be done in another order, the user may want to start rearranging before splitting, or split and rearrange the whole sentence before starting translation for example
+
+<video controls src="/0.7.0/Juxta-EN.mov" width="100%" type="video/mov"/>
+
+
+- In addition, the user may want to use those two juxtalinear conventions to ease translators understanding:
+  - Each Source Text word should be translated into only one Target Language word. When two Target Language words are needed, link them with a **dash**
+  - Use italics for needed Target Language words that are not in the Source Text. This is done by putting the word between **asterisks**
+- In general, note that the Target Text translation does not need to be elegant, it just needs to convey the sense of the words in each Source Text chunk
+

docusaurus.config.js

@@ -54,13 +54,13 @@ const config = {
           lastVersion: 'current',
           versions: {
              current: {
-               label: '0.6.1',
+               label: '0.7.0',
                badge: false
                 },
             },
 
 
-          onlyIncludeVersions: ['current', '0.5.8', '0.5.7']
+          onlyIncludeVersions: ['current', '0.6.2', '0.6.1']
 
 
 

i18n/fr/docusaurus-plugin-content-docs/current.json

@@ -2,7 +2,7 @@
 
   "version.label": {
 
-    "message": "0.6.1",
+    "message": "0.7.0",
 
     "description": "The label for version current"
 
@@ -88,6 +88,15 @@
 
   },
 
+  "sidebar.Sribe.category.Juxtalinear (Juxta)": {
+
+    "message": "Juxtalinéaire (Juxta)",
+
+    "description": "The label for category Juxtalinear (Juxta) in sidebar Sribe"
+
+  },
+
+
   "sidebar.Sribe.category.How to": {
 
     "message": "Comment faire",

i18n/fr/docusaurus-plugin-content-docs/current/scribe/Getting-Started/p0-1-what-is-scribe-SE.md

@@ -4,9 +4,10 @@ sidebar_label: Qu'est-ce que Scribe SE ?
 title: Qu'est-ce que Scribe SE ?
 slug: '/'
 ---
- :::tip Fonctionnalités introduites dans la version 0.6.1
+ :::tip Fonctionnalités introduites dans la version 0.7.0
 
-[Gestion du périmètre d'application](../Manage%20Project/Projects/p3-7-scope%20management.md)
+- [Générateur de PDF](../Modes/Common%20Functionality/p5-3-pdf%20generator.md)
+- [Juxtalinéaire (Juxta)](../Modes/Juxtalinear/p10-2-what%20is%20juxtalinear.md)
 
 ::: 
 

i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Common Functionality/p5-3-pdf generator.md

@@ -0,0 +1,48 @@
+---
+id: p5-3-pdfgenerator
+sidebar_label: Générateur de PDF
+title: Générateur de PDF
+---
+
+# Générateur de PDF
+
+Le générateur de PDF est disponible dans les modes BT, OBS et Juxta.
+
+## Limitations actuelles
+- La fermeture de la fenêtre d'exportation réinitialise ses paramètres. Si vous souhaitez essayer différents paramètres, veillez à laisser la fenêtre ouverte entre les impressions
+- Le bouton **Reset** <img src="/0.7.0/Reset.png"  width="50px" alt="reset"/> a un effet spécifique : il ne réinitialise que les champs de saisie qui sont **sous un champ Print Type** et qui ont été modifiés (ils apparaissent une fois qu'un Print type est sélectionné)
+- Pour du contenu **Translation** (BT, Juxta), la **Sélection de livre** fonctionne par activation on/off <img src="/0.7.0/Bookselection.png"  width="500px" alt="bookselection"/>
+- Les langues de droite à gauche (RTL) ne sont pas prises en charge
+
+## Étapes pour utiliser le générateur de PDF
+### Mode par défaut
+Le mode par défaut imprime le projet Scribe actuellement ouvert, avec une seule mise en page.
+- Cliquez sur le bouton **Imprimer** <img src="/0.7.0/Print.png"  width="50px" alt="print"/> dans le coin supérieur droit de l'écran
+- Une fenêtre d'exportation s'ouvre
+- Modifiez les paramètres généraux si nécessaire (**Paper size**, **Font**, **Font size**)
+- Le **Content (contenu)** ajouté sous ces paramètres généraux dépend du projet à partir duquel vous avez lancé le générateur de PDF :
+  - Un bloc **Translation** pour les projets BT et Juxta
+  - Un bloc **OBS** pour les projets OBS
+- Dans les deux cas, sélectionnez une plage d'impression :
+  - Translation : quels livres imprimer (**All Books**, **Old Testament**, **New Testament**, **Custom**)
+  - OBS : quelles histoires imprimer (le numéro de début **obs start**, et de fin **obs end**)
+
+- **Print type** : les options disponibles varient en fonction du type de bloc de contenu (Translation, OBS), sélectionnez une option de **Print type**
+- Chaque Print type a des paramètres spécifiques, ils apparaissent en dessous une fois qu'un type d'impression est sélectionné. La plupart de ces paramètres sont facultatifs
+- Choisissez un dossier d'exportation à l'aide du bouton correspondant (**Choose an export folder**)
+- Vous pouvez donner un nom à votre fichier dans le champ **your file name here**, ou il sera nommé de manière aléatoire
+- Cliquez sur le bouton **Print**
+- Si un champ obligatoire est vide ou mal rempli, une erreur apparaît sur le côté droit de la fenêtre d'exportation pour aider à localiser l'erreur
+- Sans erreurs, les étapes de génération apparaissent à droite de la fenêtre d'exportation, attendez le message final "Successful pdf generation"
+
+### Advanced mode (Mode avancé)
+Le **Mode avancé** peut être utilisé pour générer un seul PDF contenant de nombreux projets différents avec de nombreuses mises en page différentes, ainsi que des introductions et des PDF importés. Il est également plus technique à configurer.
+- Lorsque le **Advanced mode** est activé, trois nouvelles options sont disponibles :
+  - Le projet automatiquement ajouté (celui qui est actuellement ouvert dans Scribe) peut être modifié avec le bouton **Select** <img src="/0.7.0/Select.png"  width="50px" alt="select"/>, à droite du nom du projet
+  - Un nouveau bloc de contenu peut être ajouté avec le bouton **Add** <img src="/0.7.0/Addblock.png"  width="70px" alt="addblock"/>
+      - Le contenu sera imprimé par ordre d'apparition dans la fenêtre d'exportation
+      - Une fois que deux blocs de contenu ou plus sont listés, ils peuvent être supprimés avec le bouton **Corbeille**  <img src="/0.7.0/Trash.png"  width="40px" alt="trash"/>
+  - Le **Loop mode (Mode boucle)** peut être utilisé ; lorsqu'il est actif, une nouvelle option est disponible :
+    - À l'intérieur d'un bloc de contenu, un nouveau projet peut être ajouté avec le bouton **Add** <img src="/0.7.0/Addproject.png"  width="50px" alt="addproject"/>
+      - Le contenu sera imprimé par ordre d'apparition dans le bloc de contenu, **pour chaque livre ou histoire sélectionné(e)** (donc en boucle)
+      - Une fois que deux projets ou plus sont listés dans un bloc de contenu, ils peuvent être supprimés à l'aide du bouton **Corbeille**  <img src="/0.7.0/Trash.png"  width="40px" alt="trash"/>

i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Common Functionality/p5-3-font size.md → i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Common Functionality/p5-4-font size.md

@@ -1,5 +1,5 @@
 ---
-id: p5-3-font size
+id: p5-4-font size
 sidebar_label: Taille de police
 title: Taille de police
 ---

i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Common Functionality/p5-4-Sync.md → i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Common Functionality/p5-5-Sync.md

@@ -1,5 +1,5 @@
 ---
-id: p5-4-Sync
+id: p5-5-Sync
 sidebar_label: Synchroniser
 title: Synchroniser
 ---

i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Juxtalinear/p10-1-juxtalinear overview.md

@@ -0,0 +1,9 @@
+---
+id: p10-1-juxtalinearoverview
+sidebar_label: Juxtalinéaire 
+title: Juxtalinéaire 
+---
+
+Ce mode permet au traducteur de faire une traduction bilingue hyper-littérale. La traduction finale est en deux colonnes, avec le Texte Source à gauche (le plus souvent en grec ou en hébreu), et le Texte Cible à droite (une Langue Passerelle). Comme avec le mode Traduction de texte de la Bible, les traducteurs peuvent accéder à différentes versions de la Bible et les comparer dans le volet de ressources.
+
+Pour plus d'informations, voir la page [Qu'est-ce que la Juxtalinéaire](../Juxtalinear/p10-2-what%20is%20juxtalinear.md).

i18n/fr/docusaurus-plugin-content-docs/current/scribe/Modes/Juxtalinear/p10-2-what is juxtalinear.md

@@ -0,0 +1,20 @@
+---
+id: p10-2-whatisjuxtalinear
+sidebar_label: Qu'est-ce que la Juxtalinéaire
+title: Qu'est-ce que la Juxtalinéaire ?
+---
+
+Une juxtalinéaire est une vue bilingue d'un texte. Elle a deux colonnes :
+
+- à gauche, un Texte Source réarrangé et découpé en petits morceaux grammaticalement significatifs ;
+- à droite, une traduction hyper-littérale de chaque morceau.
+
+![Capture du mode Juxtalinéaire](/0.7.0/WhatisJuxtalinear-en.png)
+
+Les juxtalinéaires fournissent un pont entre les langues Source et Cible. La traduction hyper-littérale est très proche du sens du Texte Source, ce qui limite les risques de mauvaise interprétation. De plus, la taille des morceaux de phrase (quelques mots qui vont ensemble d'un point de vue grammatical) donne du contexte. Au final, les juxtalinéaires sont compréhensibles et laissent ouvertes les options d'interprétation les plus contestées.
+
+Les juxtalinéaires commencent à être utilisées dans le contexte de la CCBT. Le cas d'utilisation le plus courant est le suivant :
+- un linguiste connaissant le grec crée une juxtalinéaire *Grec vers Langue Passerelle* ;
+- Les traducteurs CCBT utilisent la juxtalinéaire en plus d'autres ressources en Langue Passerelle, pour les aider à se faire une idée plus claire du sens du texte original.
+
+Les juxtalinéaires peuvent être faites de n'importe quelle langue vers n'importe quelle autre, mais elles sont généralement faites d'une langue ancienne (grec ou hébreu) vers une langue passerelle.