nlbdev / nordic-epub3-dtbook-migrator

Tools for converting between a strict subset of DTBook and EPUB3.
http://nlbdev.github.io/nordic-epub3-dtbook-migrator/
GNU Lesser General Public License v2.1
8 stars 7 forks source link

Decide on line break convention to use for this repo and harmonise content #476

Open martinpub opened 3 years ago

martinpub commented 3 years ago

From the discussion on today's validation group meeting.

Subtasks:

martinpub commented 2 years ago

Decision on validator group meeting on October 15: Times well with #500 if there are not too many edits needed.

Next step: @kalaspuffar to create a new branch off of guidelines-revision and introduce a testing tool used in the Dotify repository, which can check e.g. line break conventions.

kalaspuffar commented 2 years ago

I've done some initial tests and the checkstyle plugin might not be the best fit.

https://github.com/checkstyle/checkstyle/issues/614#issuecomment-73045960

"Checkstyle have small team and a huge plans on extending for java language, and it should focus on one language, to be at the top among java analysers."

josteinaj commented 2 years ago

@kalaspuffar do you think you'll find a solution for this that we can include in the release, or should we do this after the release?

kalaspuffar commented 2 years ago

Hi @josteinaj

I think you could release without this update, it will introduce a lot of changes and I have not yet found a good tool for verifying XML code styling. If you have any suggestions we could look into it.

checkstyle could be modified to check XML but that is not optimal. Other tools usually pretty print XML files and that could be a solution as well, then again we need to be OK with the formatting that the tool is generating.

Best regards Daniel

martinpub commented 2 years ago

I think we should postpone this to after the release. But let's discuss tomorrow.