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

Migrate document to YAML with explicit chapter/paragraph/list numbering #8

Merged
merged 21 commits into from
Aug 27, 2023

Conversation

Iipin
Copy link
Contributor

@Iipin Iipin commented May 17, 2023

diffPDF found no differences between the new document and the old one.
Nice potential follow-ups:

  • There are some LaTeX constructs hardcoded (e.g. \subsections), it'd be nice if we could express them in a better way,
  • Adjust the workflows,
  • Get rid of the pandoc,
  • After the above: clean up the LaTeX template file.

@Iipin Iipin requested a review from m4tx May 17, 2023 22:42
Copy link
Member

@m4tx m4tx left a comment

Choose a reason for hiding this comment

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

Some downsides:

  1. We can't easily generate docx files anymore
  2. YAML format is a bit harder to read and write than the old Markdown files

We should re-enable CI (preferably using GH actions) before merging this.

paragraphs:
- id: "1"
content:
- text: "\\textbf{Stowarzyszenie Krakowski Klub Chombo}, zwane dalej \\textbf{Stowarzyszeniem}, działa na podstawie ustawy Prawo o stowarzyszeniach (Dz. U. 1989 Nr 20 poz. 104 wraz z późniejszymi zmianami) oraz niniejszego Statutu."
Copy link
Member

Choose a reason for hiding this comment

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

I'm thinking, is it necessary to have distinction text/list? In YAML, these are already two distinct data structures, so maybe we can drop these tags and make the format less verbose?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, we can – I automatically went for a tagged union so that we add another cases but no other cases came up. xd ptal

Copy link
Member

Choose a reason for hiding this comment

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

tbh now that I'm looking at this, it's hard to spot lists in this 👀 At this point, I'm fine with either version.

@Iipin
Copy link
Contributor Author

Iipin commented Jun 18, 2023

Some downsides:

1. We can't easily generate docx files anymore

2. YAML format is a bit harder to read and write than the old Markdown files

We should re-enable CI (preferably using GH actions) before merging this.

  1. docx files were added for mr. prawnik anyway so I figured we don't need them anymore
  2. true

@m4tx
Copy link
Member

m4tx commented Aug 23, 2023

@Iipin what's the current status of this?

@Iipin Iipin requested a review from m4tx August 24, 2023 20:43
@Iipin
Copy link
Contributor Author

Iipin commented Aug 24, 2023

@m4tx ready for rereview, PTAL

@Iipin Iipin merged commit c8fc7ce into master Aug 27, 2023
1 check passed
@Iipin Iipin deleted the explicit-paragraph-numbering branch August 27, 2023 15:27
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.

2 participants