librariansync icon indicating copy to clipboard operation
librariansync copied to clipboard

Documentation does not reflect Calibre JSON format support

Open nikclayton opened this issue 9 years ago • 2 comments

The collections.json example in the documentation appears to be out of date with respect to what is supported.

The Calibre export format

{
	"<CollectionName>@<Language>":
	{
		"items":
		[
			"<hash>"
		],
		"lastAccess": <epoch>
	}
}

is also valid.

This caused me some missed time while I was trying to figure out why collection creation wasn't working (see my other issue) as I originally thought it was some problem with the output format from the Calibre plugin not being recognised.

nikclayton avatar Nov 20 '16 19:11 nikclayton

Are you saying the current calibre format does not work? The example in the documentation is not supposed to be a json file generated by calibre, but something you could write by hand (originally, it was generated by librarian, another project of mine). Librariansync should support both formats.

barsanuphe avatar Nov 20 '16 21:11 barsanuphe

It does support both formats. My point is that the documentation only describes one format. So when I was trying to figure out why I was getting an error, I wasted some time chasing down what turned out to be false hypothesis that the problem was because the JSON file had the wrong structure. This would have been avoided if the documentation correctly described the different JSON formats that LibrarianSync supports.

nikclayton avatar Nov 20 '16 22:11 nikclayton