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

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

Open
3 tasks
martinpub opened this issue Jun 23, 2021 · 5 comments
Open
3 tasks
Assignees
Labels
Medium priority validator-revision EPUB 3 / HTML Validator revision: 2020-1

Comments

@martinpub
Copy link
Collaborator

martinpub commented Jun 23, 2021

From the discussion on today's validation group meeting.

Subtasks:

  • 1. Check which type(s) is/are used
  • 2. Decide on preferred one
  • 3. Harmonise all content in one go
@martinpub martinpub added the validator-revision EPUB 3 / HTML Validator revision: 2020-1 label Jun 23, 2021
@martinpub
Copy link
Collaborator Author

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
Copy link
Collaborator

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

checkstyle/checkstyle#614 (comment)

"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
Copy link
Member

@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
Copy link
Collaborator

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
Copy link
Collaborator Author

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

egli added a commit that referenced this issue Nov 1, 2021
egli added a commit that referenced this issue Nov 1, 2021
so that the editorconfig settings can be checked with Maven

Related to #476
egli added a commit that referenced this issue Nov 1, 2021
josteinaj pushed a commit that referenced this issue Nov 1, 2021
josteinaj pushed a commit that referenced this issue Nov 1, 2021
so that the editorconfig settings can be checked with Maven

Related to #476
@kalaspuffar kalaspuffar assigned josteinaj and unassigned kalaspuffar Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Medium priority validator-revision EPUB 3 / HTML Validator revision: 2020-1
Projects
None yet
Development

No branches or pull requests

3 participants