When and how does PTXprint refresh source-data from Paratext?

Question

When I first create a project in PTXprint I can link it to an existing PT-project. I have noticed that sometimes changes in the PT-data get automatically "pulled" into the PTXprint-project. 

The question

I would please like to know what the triggers are and if a user can request a "refresh". Please advise where to read up on this subject.

How can the user of PTXprint actively trigger a refresh, to positively have the very latest version of PT-data? And is there anywhere in PTXprint a way to see or check on the status (date-time-stamp) of the PT-data being used?

If the answer is "reboot your computer" or "fully shut down PTXprint", that would be an acceptable answser, if it is really the best/only way to get a refresh.


Context:
Consider this real-life situation: There is an event that has a fixed date. A special production of a publication is being prepared. The PTXprint-user, the layouter, is preparing the publication, while the "translators" with Paratext are busily finalizing "last matters" like introduction text.

Then there is feedback from the proof-prints from PTXprint back to the PT-team: Some footnotes have mild formatting issues or inconsistencies. Hyphenation could be improved for a few wordlist entries, etc. And printouts on paper are always helpful for proof-reading. Things get noticed that were overlooked on computers screens.

On certain days both teams are very busily work in the same campus, or in the same building even, and the PT-team shouts when a fresh send/receive can be done. As "reward" fresh sheets of paper might travel in the other direction. (Does this sound familiar to some? Not an ideal workflow, but it happens sometimes.) Hence my question came up.

 

Answer 1

PTXPrint should apply any changes that have been saved in the local version of the project.

Comments

Thank you Phil. So to be clear: When the team in PT has accomplished something that should go into PTXprint, they click on the icon of a 3,5" disk (mouse-over-hint "save all") and that way their work has gone into (in your words) "the local version of the (PT) project".

The PTXprint user is on a separate computer. He has got both PT and PTXprint, while the translation team does not have PTXprint on all machines. The PTXprint user will then receive the fresh data via send/receive I suppose?

Or does he need to click again, on his computer after each send/receive, on the "save" button, to trigger the changes to go into PTXprint?

---

When a user does S/R and receives data, the files that they receive are saved to their computer. They do not need to click on the save icon. You can also save through the main menu or the shortcut (Ctrl +S).

Answer 2

the "layout only" check button at the bottom of the screen  is important here. By default it is checked and that tells PTXprint not to update the files (for speed). If it is unchecked (or "_") it will update the files from Paratext (assuming they are saved). You don't to do anything in Paratext.

Comments

Martin, I'm trying to understand this. In my testing I see changes from Paratext applied to the text in PTXPrint whether or not that option is checked.

---

When Phil writes "I'm trying to understand this", I need to pause and consider, whether I, as a noob on PTXprint, need to worry.

Earlier today I had written this little paragraph (and then deleted, since I tend to write too long):
"We could enter some testing-data into the PT-project. Like a dummy-sentence, or some invented extra footnote. And then try "actions" and see which ones bring the changes over to PTXprint. But there is life-experience and book-advice to be very careful with such strategies. Especially in the final stages before a production or a version-release. Too often dummy-data has made its way into a final product. 

Or even if we manage to clear-up properly, we might be drawing the wrong conclusions from a few tests based on guesses. This is why I am asking where to read the facts in the documentation."

And with hindsight I was right: Even having searched online docs and having searched PTXprint, I would have never noticed the small option-box in the corner. I was searching for words like "refresh" and "update" and this option is giving hint-help about "regenerating". And I was naively thinking about PT only, while PTXprint looks further at "processing USFM scripture content" from several possible sources. My bad.

I am stressed at the moment, but very much interested in what you find out Phil. I want to understand PTXprint, because I can feel, that I will be using it a lot in coming years. 

I am also willing to help, because I appreciate this forum so much. I could do some tests if you give clear instructions and if you need real-work-machines to double-check something. I just need to be very careful not to mess our data with experiments in this phase.

Answer 3

Hi Tim,

The "Layout Only" feature is a relatively new one introduced since the context menu adjustments (in the PDF Viewer) became possible. The idea is that PTXprint shouldn't need to re-process all the USFM data through a complex set of transformations every time a user adjusts a paragraph (grow by a line, or shrink to fit, etc.); so it just runs the layout part (XeTeX) of the process.

When "Layout Only" is unchecked, the sequence is: Processing -> Laying Out -> Finalizing

When "Layout Only" is checked, the sequence is: Processing -> Laying Out -> Finalizing

If on the other hand you make a change to certain settings, then the data has to be (re-)processed, and it automatically detects that and does so (notice the third [-] state that the checkbox takes temporarily for the 1st run after settings have changed). It is also smart enough to notice if the USFM files in Paratext have been updated since the last print run and ensures that they get (re-)processed. So, in theory this all "just works".

If you are paranoid about it missing an update, then just leave that "Layout Only" option unchecked and wait the extra few seconds each time you hit Print.

One caveat you need to know about: PTXprint does NOT update the PicList automatically. So if you change details (like the caption, or the illustration itself) in the Paratext files, then you will need to visit the Pictures tab and update things there.

I hope this helps you understand how it works. We are in the process of updating the "documentation" which is primarily in the Tooltips, and also in the MASTER SLIDES which are also being updated in preparation for an upcoming training event at EMDC next month.

Answer 4

Several good answers, no best answer, so I will summarize for my own lookup later, what is the answer to my question:

- Normally, PTXprint will automatically notice when USFM data has changed.

- When a user wants to trigger actively that PTXprint should "notice" fresh USFM data, either a send/receive (does include save) or save-project in PT does the trick.

- Even if PTXprint will notice fresh USFM data, it might ignore that data, while the "layout only" option-box is ticked in the bottom-right corner.

- There is no feedback, visual or other, for the user to confirm that fresh USFM data has been detected and processed (or not) by PTXprint. 

- So when working on print-preparing a document, which is based on a PT-project (which is also actively being worked-on at the content-level (by other team members)), a good habit is to check that layout-only is unchecked, then click "send/receive" or "save" once in PT, and then click "Print (Update) PDF" to see the result of your latest settings tweaks or text-flow adjustments or what changes were brought-in from the latest edits in the USFM data.

Note to self:
It might be obvious, and is probably somewhere in the documentation: PT and PTXprint are friendly companion tools. PT can be running on the same computer, while PTXprint is being used. And PTXprint never changes USFM data of a PT-project, even while its files are being stored inside the PT-project-folder; data flows in a one-way system from PT to PTXprint.

 

Comments

_{Sorry Tim, but your answer is not correct.}

PTXPrint will always use the latest "saved" data. If you don't save the data in Paratext, PTXPrint will not see it. PTXPrint will never ignore data that has been saved. The Layout Only option is there to assist PTXPrint to make layout changes more quickly.

The one exception to how PTXPrint handles Paratext data is in regard to illustrations. In PTXPrint you create a file of the illustrations and this does not get updated automatically. You should review any illustrations if you have made changes to them in Paratext.

---

Thank you @Phil_Leckrone for finding mistakes in my summary. I have just un-selected my summary as "best answer", because it is not correct. I invite the PTXPrint pros to write a better summary, so that we all have one location with a complete and correct documentation on this subject.

And please do not get angry, but I will today post a fresh question, with an opposite need. And this is no joke, comes from a real-life project.

Answer 5

I need to raise one special aspect, which also belongs to the issue of the link (or sync) between PT and PTXPrint:

There is the option to "import" hyphenation-data from a PT project. This has got a dedicated button. And it is not obvious what happens after the initial import:

• Does PTXPrint treat the import like "the happy beginning of a wonderful relationship", i.e. create a link and will from then on update hyphenation-data from the PT project, whenever it is extended, edited or corrected in PT?

• Or is the import a historic "once in a lifetime" until button does make it all new?

This is important for our publishing, since we want to keep very fundamental and complete hyphenation-data in PT. And have more custom and specific-to-context and audience options for each PTXPrint-project. 

So we have discovered how to hack the imported hyphanation-data (see my extra question here: https://support.bible/15465/may-i-edit-hyphen-project-tex). But we need to know the dynamics of "refreshing", in order to have a stable work-flow and to avoid nasty surprises, when data in PT is changed.