MobileRead Forums - View Single Post - Sigil-1.2.0 Released

KevinH · 03-29-2020, 10:33 AM

Hi All,

A few words of advice for those interested in trying out the new Checkpoint features:

1. Checkpoints make use of the unique uuid dc:identifier to identify your epub as both file names and book titles can and do change.

So please remember to save your file once in Sigil before the first checkpoint to ensure Sigil has added the uuid based dc:identifier.

2. Using Prettifying can change an enormous amount of whitespace in a document and these changes can make it hard to see later changes. So if you are going to prettify your epub, either do it first thing before your initial checkpoint, or make a new checkpoint immediately afterward prettifying to act as a new base for comparison to make detecting later changes easier.

3. The Sigil Checkpoint functionality is actually built upon a local git repository that is created and maintained in python. If you look in your Sigil Preferences Folder you will see a new folder called "repo". Inside that folder is where the git repositories will reside.

4. If you are already a git user and would like to used advanced git command lines on your epub repository you can do that quite easily. Please be aware of a few things:

- There is a .bookinfo file that stores info about the book, please do not remove it.

- We use git tag objects to create a tag, not lightweight tags.

- When done making changes, your git working directory should always be left with
the files as if a fresh checkout of HEAD has been done as the Sigil code
expects it to be in that state.

We plan on extending this Checkpoint functionality via an upcoming AdvancedCheckpoint Sigil Plugin as some future date to allow selective restoring at the file level not just at the epub checkpoint level.

Any feedback on these new Checkpointing features welcome.

Thanks,

KevinH and DiapDealer

03-29-2020, 10:33 AM	#2
KevinH Sigil Developer Posts: 8,805 Karma: 6000000 Join Date: Nov 2009 Device: many	Hi All, A few words of advice for those interested in trying out the new Checkpoint features: 1. Checkpoints make use of the unique uuid dc:identifier to identify your epub as both file names and book titles can and do change. So please remember to save your file once in Sigil before the first checkpoint to ensure Sigil has added the uuid based dc:identifier. 2. Using Prettifying can change an enormous amount of whitespace in a document and these changes can make it hard to see later changes. So if you are going to prettify your epub, either do it first thing before your initial checkpoint, or make a new checkpoint immediately afterward prettifying to act as a new base for comparison to make detecting later changes easier. 3. The Sigil Checkpoint functionality is actually built upon a local git repository that is created and maintained in python. If you look in your Sigil Preferences Folder you will see a new folder called "repo". Inside that folder is where the git repositories will reside. 4. If you are already a git user and would like to used advanced git command lines on your epub repository you can do that quite easily. Please be aware of a few things: - There is a .bookinfo file that stores info about the book, please do not remove it. - We use git tag objects to create a tag, not lightweight tags. - When done making changes, your git working directory should always be left with the files as if a fresh checkout of HEAD has been done as the Sigil code expects it to be in that state. We plan on extending this Checkpoint functionality via an upcoming AdvancedCheckpoint Sigil Plugin as some future date to allow selective restoring at the file level not just at the epub checkpoint level. Any feedback on these new Checkpointing features welcome. Thanks, KevinH and DiapDealer