Add first pass Send/Receive

[tjcouch-sil]

User Story As a translator, I want to be able to collaborate with others on my Scripture projects so that we can work together effectively.

Description Develop a rough-cut first draft of Send/Receive functionality in Platform.Bible.

• [x] Create simple S/R dialog
  • Internet server only for now (try putting in a selector that only has one option)
• [x] Web view menu item to S/R a project (S/R and displays results)

UX Design (in progress) https://www.figma.com/design/2p7VtjVtRzp5e8zWi5ZCSy/Send%2FReceive?node-id=0-1&t=UIbKzXg4pwcS6EB7-0

PT9 Send/Receive Dialog

S/R Results dialog

[tjcouch-sil]

S/R Dialog

Methods from SendReceiveProjectsForm.cs

• [ ] Determine if internet S/R is available
  • CheckSourceIsAvailable - logic for internet S/R
  • SetInternetDisabledText - indicates why internet S/R is not available
• [x] List projects available for S/R
  • Get list of online projects and S/R-enabled local projects
  • maybe constructor has info? See CoaxUserToDoASendReceive. Nope
  • uiProjectList_RenderItem seems to indicate _sharedProjects is displayed
  • LoadAndDisplay sets up srSourceType and source line 1509 and runs LoadSourceRepositories which runs the actual retrieval logic CreateSharedProjectListInternal
  • Determine new/edited status
  • Maybe trace GetProjectsModifiedByAnyone? UpdateEnabledStates (called by DisplayProjectList)? ChangeActiveState? ChangeEnabledState?
• [ ] Do the S/R
  • uiSendReceive_Click -> PerformSendReceive
  • SharingLogic.ShareChanges
• [ ] Display results
  • ChangeListForm.CreateHTML

[jcuenod]

Not sure if this is an appropriate place for what is essentially a feature request, but I often find myself wanting to "receive without sending". Conflict resolution is obviously a complicated problem - in my case, I am always willing to destroy local changes. I am wanting to be sure I don't push local changes. At the very least, I want to note this here because I'd love to see the design support this kind of feature in the future, even if not immediately.

[tjcouch-sil]

Looks like we will have to find mercurial on the system or bundle it in like Paratext does (on Windows). There are also a handful of files we need to distribute. Some notes from a discord conversation:

• Paratext uses 4.8.2
• Newer than 4.8.2 will have problems with the init function with default config. John W thinks this would only affect if P.B created a USB repo and Paratext tried to use it. But there are init arguments that make it backwards compatible
• Paratext has Python 2.7 scripts that Mercurial must be able to run. Therefore it is stuck on versions 4.3-6.1.4
• We may be able to build Mercurial ourselves and distribute it ourselves
• It seems the oldest Mac build of Mercurial on the site is TortoiseHg 5.3
• Macports also seems to have version 3.9.2
• I have no idea how getting Mercurial for linux would work. It's on apt-get and some other package repos, but I can't list versions. There are also some rpm files on the site.

Download - Mercurial - explanation of various options available UnixInstall - Mercurial - instructions for building versions on unix? Maybe not Mercurial downloads - download links DeveloperRepos - Mercurial - explanation of what repos are what hg-stable: 197f092b2cd9 / - 4.8.2 version source BuildingOnWindows - Mercurial - old instructions for building on Windows BuildingPackages - Mercurial

[tjcouch-sil]

[tjcouch-sil]

To set up Paratext 10 Studio for using Send/Receive (for now - will likely improve in https://github.com/paranext/paranext-core/issues/971):

Get Paratext Registry access:

• Production: https://registry.paratext.org/
• Development: https://registry-dev.paratext.org/

On Windows:

1. Install Paratext 9
2. Enter your registration information in Paratext 9

On Linux or Mac:

1. Install Mercurial (Ubuntu: run sudo apt-get install mercurial)
2. Choose one of the following:
   • Copy InternetSettings.xml and RegistrationInfo.xml from a Windows machine that has already set up registration information in Paratext 9 from the Windows directory %localappdata%/Paratext95 to the Linux or Mac directory ~/.local/share/Paratext95
   • Create your own ~/.local/share/Paratext95/InternetSettings.xml and ~/.local/share/Paratext95/RegistrationInfo.xml based on the templates below.
     • Change SelectedServer to Production if you want to use the production server.
     • Choose between Enabled, VpnRequired, Disabled, and ProxyOnly for PermittedInternetUse

Sample InternetSettings.xml:

<?xml version="1.0" encoding="utf-8"?>
<InternetSettingsMemento>
  <SelectedServer>Development</SelectedServer>
  <PermittedInternetUse>Enabled</PermittedInternetUse>
  <ProxyPort>0</ProxyPort>
</InternetSettingsMemento>

Sample RegistrationInfo.xml:

<?xml version="1.0" encoding="utf-8"?>
<RegistrationData>
  <Name>Your Name</Name>
  <Code>YourParatext9RegistrationCode</Code>
  <Email>YourEmailAddress@example.com</Email>
  <SupporterName />
</RegistrationData>

[tjcouch-sil]

PRs: Made extension contributions load in order, added spinner, updated ParatextData to 9.5.0.6, misc bug fixes and improvements - 8 unreplied - Reviewable Include untracked changes aka new code files in patches - Reviewable Added send/receive service to dotnet process by tjcouch-sil · Pull Request #3 · paranext/paratext-10-studio Added Send/Receive extension including dialog and menu items by tjcouch-sil · Pull Request #67 · paranext/paratext-bible-internal-extensions Added link to S/R setup instructions, fixed default hg paths for mac by tjcouch-sil · Pull Request #4 · paranext/paratext-10-studio

Documentation: Troubleshooting Guide · paranext/paranext Wiki Set up Send Receive Functionality · paranext/paranext Wiki

[roopa0222]

Verified the Send/Receive functionality on the Paratext 10 studio.

1. Verified that all the projects that I have access to are displayed in the Send/Receive dialog
2. Verified that the changes I made are Send/Receive
3. Verified I can get all the changes made by other Users (TJ)
4. Verified that a merge conflict is displayed when 2 users made changes on the same book and same verse. Gen 1 verse showed up as conflict as changes are made in the same verse.
5. Verified the book links on the changes and merge conflicts, on click opens up the book in the editor.