Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add page marker flags feature #1298

Merged

Conversation

windymilla
Copy link
Collaborator

@windymilla windymilla commented Jun 4, 2024

This feature is in GG2, and allows editing in a different editor without losing the page break positions.

In particular, swapping between GG1 & GG2 should be easy, but any other editor is OK too.

Linked with GG2 PR: DistributedProofreaders/guiguts-py#272

This feature is in GG2, and allows editing in a different
editor without losing the page break positions.

In particular, swapping between GG1 & GG2 should be
easy, but any other editor is OK too.
@windymilla
Copy link
Collaborator Author

Testing notes:

  1. File-->Project-->Add Page Marker flags in GG1
  2. Save file from GG1
  3. Load in another editor
  4. If that editor is GG2, then after loading the file, you can File-->Project-->Remove Page Marker flags in GG2 if you don't want them to get in the way.
  5. Make the edits you want to in the other editor.
  6. If that editor is GG2, then use File-->Project-->Add Page Marker flags in GG2 before a final save.
  7. Load the file in GG1 again
  8. File-->Project-->Remove Page Marker flags in GG1

These notes should also work if "GG1" & "GG2" are swapped above.

In summary, in both directions of transfer...
Immediately before saving, Add Page Markers, and immediately after loading, Remove Page Markers
(only if the editor is a version of Guiguts, of course, or it won't have those options).

@srjfoo
Copy link
Member

srjfoo commented Jun 7, 2024

I found the File->Set Page Markers option in GG1 confusing, but remembered to look it up in the manual. Is this something that just won't be implemented in GG2, or is that something else we need to open an issue about?

Copy link
Member

@srjfoo srjfoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't go out of my way to try to break things on this one. I think that anyone who uses this should be very aware of when it should and shouldn't be used, because I'm not sure that there's much that can be done to protect the PPer from stupid mistakes (which we all make).

Observation: When testing I made a point of checking the contents of both bin files both before and after saving in the gg version I currently had it open in. My main test was just to add some lines at the top of the file and verify that when I saved, the start location for the second page changed to the new line number. It worked as expected for me, but it probably should be documented that until a save is done, the bin/json files won't be updated (unless, of course, that's pounded into PPers' heads much earlier in the process 😁).

@windymilla
Copy link
Collaborator Author

I found the File->Set Page Markers option in GG1 confusing, but remembered to look it up in the manual. Is this something that just won't be implemented in GG2, or is that something else we need to open an issue about?

I don't think we need it in GG2. Our new page marker flags remove any need that there may have been in the past. Historically, there is a Pref in GG1 that lets you not set the page markers when you first load a file, and then you would have had to use that menu option to set them later. I wonder if many versions ago, that was the only way of setting page markers, then someone added the feature to auto-set them when the file was loaded (also adding a Pref to keep the old-old-timers happy)

@windymilla
Copy link
Collaborator Author

It worked as expected for me, but it probably should be documented that until a save is done, the bin/json files won't be updated (unless, of course, that's pounded into PPers' heads much earlier in the process 😁).

However, if you don't do a save, then the changes you've made to the file itself won't be updated, so you've just loaded a file and done nothing to it (or discarded your changes). So, I don't think there would be any need to save the json file in that circumstance.

@windymilla windymilla merged commit d6335f6 into DistributedProofreaders:master Jun 7, 2024
1 check passed
@windymilla windymilla deleted the page-marker-flags branch June 7, 2024 18:49
@srjfoo
Copy link
Member

srjfoo commented Jun 7, 2024

It worked as expected for me, but it probably should be documented that until a save is done, the bin/json files won't be updated (unless, of course, that's pounded into PPers' heads much earlier in the process 😁).

However, if you don't do a save, then the changes you've made to the file itself won't be updated, so you've just loaded a file and done nothing to it (or discarded your changes). So, I don't think there would be any need to save the json file in that circumstance.

Good point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Page Marker Flags feature
2 participants